aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorAaron LI <aly@aaronly.me>2018-11-08 17:07:27 +0800
committerAaron LI <aly@aaronly.me>2018-11-08 17:07:27 +0800
commitbd9ac10f302fbf735c7adc120fefeb578fa01906 (patch)
tree8f5ce7a8c636b0435a30f5f3bf18cf5ef5263fe9 /README.rst
parenta855ea02d9563b5ea1b701dea7c15806ad955ce3 (diff)
downloadfg21sim-bd9ac10f302fbf735c7adc120fefeb578fa01906.tar.bz2
README: Clean up and improve the installation
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst24
1 files changed, 10 insertions, 14 deletions
diff --git a/README.rst b/README.rst
index dc341a3..fb8f962 100644
--- a/README.rst
+++ b/README.rst
@@ -32,26 +32,22 @@ Features
* Command line tools, utilities, and resuable modules
-Requirements
+Installation
------------
-* Linux operating system (other UNIX-like systems not tested)
-* `Python <https://www.python.org/>`_
-* `CFITSIO <https://heasarc.gsfc.nasa.gov/fitsio/fitsio.html>`_
-* `HEALPix <http://healpix.sourceforge.net/>`_:
- only the C++ library required by `healpy <https://github.com/healpy/healpy>`_.
-* `LLVM <http://llvm.org/>`_:
- (required by `llvmlite <http://llvmlite.pydata.org/>`_ which is a
- dependency of `Numba <http://numba.pydata.org/>`_)
+1. Install the required software and libraries:
+ * `CFITSIO <https://heasarc.gsfc.nasa.gov/fitsio/fitsio.html>`_
+ * `HEALPix <http://healpix.sourceforge.net/>`_:
+ only the C++ library required by
+ `healpy <https://github.com/healpy/healpy>`_.
+ * `LLVM <http://llvm.org/>`_:
+ (required by `llvmlite <http://llvmlite.pydata.org/>`_ that is
+ further required by `Numba <http://numba.pydata.org/>`_)
-Installation
-------------
-1. Clone this repository::
+2. Clone this repository::
$ git clone https://github.com/liweitianux/fg21sim
-2. Install the above required software and libraries.
-
3. Install the required third-party Python packages.
And it is recommended to use the `virtual environment`_::