Skip to content

Commit d1e37e7

Browse files
committed
Update README as markdown
1 parent ffaa9fa commit d1e37e7

File tree

2 files changed

+24
-35
lines changed

2 files changed

+24
-35
lines changed

README

Lines changed: 0 additions & 35 deletions
This file was deleted.

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# lsst-sconsUtils
2+
3+
[![codecov](https://codecov.io/gh/lsst/sconsUtils/branch/main/graph/badge.svg?token=2BUBL8R9RH)](https://codecov.io/gh/lsst/sconsUtils)
4+
5+
sconsUtils is a package in the [LSST Science Pipelines](https://pipelines.lsst.io/).
6+
7+
This package contains utility scripts for building pipelines packages with
8+
[SCons](https://scons.org/), and is required to build most pipelines packages.
9+
SCons can be used to build C++ and Python (with pybind11 bindings) packages;
10+
see the [stack package templates](https://github.com/lsst/templates/tree/main/project_templates/stack_package)
11+
if this is of interest.
12+
13+
This is a **Python 3 only** package (we assume Python 3.10 or higher).
14+
15+
This software is dual licensed under the GNU General Public License
16+
(version 3 of the License, or (at your option) any later version,
17+
and also under a 3-clause BSD license. Recipients may choose which of these
18+
licenses to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
19+
respectively.
20+
21+
This package can only be imported through a SCons script; as a result, it is
22+
generally not possible to inspect the docstrings interactively. Refer to the
23+
locally-built documentation or at https://pipelines.lsst.io/, or read the
24+
source code instead.

0 commit comments

Comments
 (0)