aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAaron LI <aaronly.me@gmail.com>2016-05-27 22:59:19 +0800
committerAaron LI <aaronly.me@gmail.com>2016-05-27 22:59:19 +0800
commit11ed216abc58da6a8a91cc1a9ea980a573e9d881 (patch)
tree5d5f8c7c80c742347b878c2fe59275cf75c91589 /README.md
parent7eed518ad3e4ef57480a2718866dce0c48fc69b1 (diff)
downloadchandra-acis-analysis-11ed216abc58da6a8a91cc1a9ea980a573e9d881.tar.bz2
README.md: fix markdown syntax
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 16 insertions, 6 deletions
diff --git a/README.md b/README.md
index 1943af0..39128ad 100644
--- a/README.md
+++ b/README.md
@@ -6,22 +6,31 @@ Weitian (Aaron) LI, Junhu GU, and Zhenghao ZHU
Install/Compile
---------------
-needs `libgsl-dev'
-(1) mass_profile
+Dependence:
++ ``libgsl-dev``
+
+1. ``mass_profile``
+```
$ cd mass_profile
$ make clean
$ heainit # initilize heasoft, to link libpgplot.a and libcpgplot.a
$ ./init.sh
$ make
-(2) cosmo_calc
+```
+
+2. ``cosmo_calc``
+```
$ cd tools/cosmo_calc
$ make clean; make
$ cp cosmo_calc ~/bin # within $PATH
+```
Settings
--------
-## Add following settings to ~/.bashrc
+Add the following settings to your shell's initialization file
+(e.g., ``~/.bashrc`` or ``~/.zshrc``).
+```
# environment variables:
export MASS_PROFILE_DIR="/path/to/mass_profile"
export CHANDRA_SCRIPT_DIR="/path/to/script"
@@ -36,15 +45,16 @@ alias fitsbp="${MASS_PROFILE_DIR}/fit_sbp.sh"
alias fitwang="${MASS_PROFILE_DIR}/fit_wang2012_model tcl_temp_profile.txt"
alias calclxfx="${MASS_PROFILE_DIR}/calc_lxfx_simple.sh"
alias getlxfx="${MASS_PROFILE_DIR}/get_lxfx_data.sh"
+```
Usage
-----
-see 'HOWTO_chandra_acis_process
+See the doc ``HOWTO_chandra_acis_analysis.txt``
License
-------
-The tools are distributed under the MIT license unless otherwise declared.
+The tools are distributed under the **MIT license** unless otherwise declared.
The documents are distributed under the ??? license (comming...).