Added intro to docs

vcalderon2009 · Feb 21, 2018 · 7a54178 · 7a54178
1 parent b1f1c46
commit 7a54178
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,9 @@ Repository for creating ECO synthetic catalogues
 
 **Author**: Victor Calderon ([victor.calderon@vanderbilt.edu](mailto:victor.calderon@vanderbilt.edu))
 
+[![Documentation Status](https://readthedocs.org/projects/eco-mocks-catls/badge/?version=latest)](http://eco-mocks-catls.readthedocs.io/en/latest/?badge=latest)
+
+
 ## Installing Environment & Dependencies
 
 To use the scripts in this repository, you must have _Anaconda_ installed on the systems that will be running the scripts. This will simplify the process of installing all the dependencies.

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,11 +1,15 @@
 .. ECO_Mocks_Catls documentation master file, created by
    sphinx-quickstart.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+   Main page for the ECO-RESOLVE Mock catalogues documentation
 
-ECO_Mocks_Catls documentation!
+ECO/RESOLVE Synthetic Catalogues
 ==============================================
 
+This is the documentation for 
+the `ECO Mocks Catalogue <https://github.com/vcalderon2009/ECO_Mocks_Catls>`_
+repository. In here, you will find the structure and functions used 
+in this repository.
+
 Contents:
 
 .. toctree::