fix docs

VU-IVM · Jan 27, 2019 · 8b010f5 · 8b010f5
1 parent cc3e004
commit 8b010f5
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/docs/source/getstarted.rst b/docs/source/getstarted.rst
@@ -1,4 +1,6 @@
 
 =======================================
-Getting started with the DamageScanner
+Getting started 
 =======================================
+
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,9 +3,26 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to the DamageScanner's documentation!
+DamageScanner's documentation!
 =============================================
 
+Python toolkit for direct damage assessments for natural disasters.
+
+Installation
+------------
+1. Clone the repository or download the package on your computer and extract the folder.
+2. Go to the DamageScanner folder in your command prompt or bash.
+3. Type ``python setup.py install`` and it should install itself into your python environment.
+4. Now you can import the package like any other package!
+
+To-do:
+------
+* Improve ReadtheDocs.
+* Add plot capabilities.
+* Add examples.
+* Develop automated damage assessments using OpenStreetMap data.
+
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
@@ -20,3 +37,4 @@ Indices and tables
 ==================
 
 * :ref:`search`
+