aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAaron LI <aaronly.me@outlook.com>2016-09-20 17:28:36 +0800
committerAaron LI <aaronly.me@outlook.com>2016-09-20 17:28:36 +0800
commit393f6b3833e5ce1a197d507e628f7452de1b65a3 (patch)
treeee7471de55a0c4aaba58b696ad38756b80db5596
parentfc2724a4cde7f0ff2aa724b9a63d67e7f98a47b4 (diff)
downloadfg21sim-393f6b3833e5ce1a197d507e628f7452de1b65a3.tar.bz2
Change README using reStructuredText syntax
-rw-r--r--README.md31
-rw-r--r--README.rst35
2 files changed, 35 insertions, 31 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index 4ad8b26..0000000
--- a/README.md
+++ /dev/null
@@ -1,31 +0,0 @@
-Realistic Foregrounds Simulation for EoR 21cm Signal Detection
-==============================================================
-
-> **WARNING**:
-> This repository is at its very early stage and under heavy development,
-> do *NOT* use at the moment!
-
-This repository provides the tools to simulate the currently *most realistic*
-(to our knowledge) low-frequency radio foregrounds, which can be further
-used to test various foreground removal or separation methods, for the
-purpose of successfully detecting the 21cm cosmological signal arising
-from the netrual hydrogen (HI) of epoch of reionization (EoR).
-
-
-Contributions
--------------
-Great! Be sure to consult the [contribution guidelines](CONTRIBUTING.md).
-
-
-Authors
--------
-* Weitian LI <[liweitianux@live.com](mailto:liweitianux@live.com)>
-
-
-License
--------
-Unless otherwise declared:
-
-* Codes developed by our are distributed under the **[MIT license](https://opensource.org/licenses/mit-license.php)**;
-* Documentations and products generated by our are distributed under the **[Creative Commons Attribution 3.0 license](https://creativecommons.org/licenses/by/3.0/us/deed.en_US)**;
-* Third-party codes and products used are distributed under their own licenses.
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..d2accc3
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,35 @@
+Realistic Foregrounds Simulation for EoR 21cm Signal Detection
+==============================================================
+
+**WARNING:**
+This repository is at its very early stage and under heavy development,
+do *NOT* use at the moment!
+
+This repository provides the tools to simulate the currently *most realistic*
+(to our knowledge) low-frequency radio foregrounds, which can be further
+used to test various foreground removal or separation methods, for the
+purpose of successfully detecting the 21cm cosmological signal arising
+from the netrual hydrogen (HI) of epoch of reionization (EoR).
+
+
+Contributions
+-------------
+Great! Be sure to consult the guidelines in ``CONTRIBUTING.md``.
+
+
+Authors
+-------
+
+- Weitian LI <``liweitianux@live.com``>
+
+
+License
+-------
+Unless otherwise declared:
+
+- Codes developed by our are distributed under the **`MIT license`_**;
+- Documentations and products generated by our are distributed under the **`Creative Commons Attribution 3.0 license`_**;
+- Third-party codes and products used are distributed under their own licenses.
+
+.. _`MIT license`: https://opensource.org/licenses/mit-license.php
+.. _`Creative Commons Attribution 3.0 license`: https://creativecommons.org/licenses/by/3.0/us/deed.en_US;