[docs] Adds a basic tutorial on how to install the sagittal_average

dpshelio · dpshelio · commit d8a0265d25f1 · 2024-11-17T15:02:25.000Z
diff --git a/docs/how_to/index.rst b/docs/how_to/index.rst
@@ -0,0 +1,11 @@
+How to...
+=========
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Guides:
+
+   installation
+
+
+
diff --git a/docs/how_to/installation.rst b/docs/how_to/installation.rst
@@ -0,0 +1,23 @@
+Get Started
+===========
+
+Installation
+------------
+
+To install this library, that's not yet on pypi you can do so by:
+
+.. code-block:: bash
+
+    $ python -m venv brain
+    $ . brain/bin/activate
+    $ pip install git+git://github.com/UCL-COMP0233-24-25/sagittal_average
+
+
+Then you'll be able to use on all your 2D brain data as:
+
+.. code-block:: bash
+
+    $ sagittal_brain.run_averages("input_file.csv", "ouput_file.csv")
+
+
+Have fun!
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,4 +10,5 @@ Welcome to sagittal-average's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   How to... <how_to/index>
    API <api/modules>
