From b94d5ab21ea0be610e92d25c2eca7b7d31ff94ea Mon Sep 17 00:00:00 2001
From: Raphael <raphael.sturgis@gmail.com>
Date: Tue, 2 Nov 2021 11:10:42 +0100
Subject: [PATCH] update doc

---
 README.rst | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.rst b/README.rst
index c9f62bf..c0ffc58 100644
--- a/README.rst
+++ b/README.rst
@@ -1,2 +1,30 @@
-# skais
+skais
+=====
 
+``skais`` is a Python package for Raphael Sturgis' PhD at LIS and Searoutes.
+
+Install
+-------------
+
+To install the package for development with ``pip``, run from the top-level
+source (i.e., this file's directory)::
+
+    pip install -e .
+
+To run unitary tests, install required packages::
+
+    pip install -r requirements.txt
+
+
+
+Dataset installation
+--------------------
+Download the data to your favorite directory.
+
+Then run function ``skais.Utils.config.generate_config`` in order to
+create a configuration file and modify it to specify the path to your data
+folder. The location of the configuration file is given by function
+``skais.Utils.config.get_config_file``.
+
+Once the configuration is set, the path to the data folder is
+returned by function ``skais.Utils.config.get_data_path``.
\ No newline at end of file
-- 
GitLab