aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAaron LI <aaronly.me@outlook.com>2017-02-08 09:52:09 +0800
committerAaron LI <aaronly.me@outlook.com>2017-02-08 09:52:09 +0800
commitb93b5dffa1473dfaeb7a903fdd2777caa4f65d91 (patch)
tree073cdad0827d64b5d1f22c117ec84f09baf7e00a /README.md
parentf7db09734f6867ceed28789ae6d78f66bc7d03fe (diff)
downloadchandra-acis-analysis-b93b5dffa1473dfaeb7a903fdd2777caa4f65d91.tar.bz2
README.md: Update license and format.
Diffstat (limited to 'README.md')
-rw-r--r--README.md59
1 files changed, 35 insertions, 24 deletions
diff --git a/README.md b/README.md
index c74ebab..84124f6 100644
--- a/README.md
+++ b/README.md
@@ -49,28 +49,35 @@ TODO
Installation
------------
1. Clone this repository with ``opt_utilities``:
-```
-$ git clone --recursive https://github.com/liweitianux/chandra-acis-analysis.git
-```
-or in this way:
-```
-$ git clone https://github.com/liweitianux/chandra-acis-analysis.git
-$ cd chandra-acis-analysis
-$ git submodule update --init --recursive
-```
-2. Build ``mass_profile``
-```
-$ cd mass_profile
-$ make clean
-$ make
-(or use this to enable OpenMP)
-$ make OPENMP=yes
-```
+ ```
+ $ git clone --recursive https://github.com/liweitianux/chandra-acis-analysis.git
+ ```
-3. Get and build ``cosmo_calc``
-Get it from repository [atoolbox](https://github.com/liweitianux/atoolbox),
-under the directory ``astro/cosmo_calc``.
+ or in this way:
+
+ ```
+ $ git clone https://github.com/liweitianux/chandra-acis-analysis.git
+ $ cd chandra-acis-analysis
+ $ git submodule update --init --recursive
+ ```
+
+2. Build ``mass_profile`` tools:
+
+ ```
+ $ cd mass_profile
+ $ make clean
+ $ make
+ (or use this to enable OpenMP)
+ $ make OPENMP=yes
+ ```
+
+3. Get and build ``cosmo_calc``:
+
+ Get it from repository [atoolbox](https://github.com/liweitianux/atoolbox),
+ under the directory ``astro/cosmo_calc``.
+ Then place the built binary to where can be searched by shell
+ (e.g., ``~/bin``, and add ``~/bin`` to ``$PATH``).
Settings
@@ -94,12 +101,12 @@ alias getlxfx="${MASS_PROFILE_DIR}/get_lxfx_data.sh"
Usage
-----
-See the doc ``HOWTO_chandra_acis_analysis.txt``
+See the doc [``HOWTO_chandra_acis_analysis.txt``](HOWTO_chandra_acis_analysis.txt)
Useful Links
------------
-* [Chandra Chaser](http://cda.harvard.edu/chaser/)
+* [Chandra Data Archive](http://cda.harvard.edu/chaser/)
* [NED search by name](http://ned.ipac.caltech.edu/forms/byname.html)
* [SIMBAD](http://simbad.u-strasbg.fr/simbad/)
* [HEASARC nH tool](https://heasarc.gsfc.nasa.gov/cgi-bin/Tools/w3nh/w3nh.pl)
@@ -107,5 +114,9 @@ Useful Links
License
-------
-* The tools are distributed under the **MIT license** unless otherwise declared.
-* The documents are distributed under the ??? License (TBD).
+Unless otherwise declared:
+
+* Codes developed by us are distributed under the
+ [MIT License](https://opensource.org/licenses/MIT);
+* Documentations and products generated by us are distributed under the
+ [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/us/deed.en_US).