Adjusting documentation

2020-11-23 00:44:32 +01:00
parent 948573cb59
commit d865b3454e
5 changed files with 45 additions and 35 deletions
--- a/docs/quickstart.rst
+++ b/docs/quickstart.rst
@@ -1,5 +1,25 @@
+.. image:: ../Gallery/logo.png
+   :align: center
+
 Quickstart
-==================
+===========

-Coming soon....
+Installing Inkycal
+------------------
+Install inkycal  directly via the github repo:

+.. code-block:: sh
+    :linenos:
+
+    # clone the repo
+    git clone -b  release/2.0.0 https://github.com/aceisace/Inky-Calendar Inkycal
+
+    # go to downloaded repo folder
+    cd Inkycal
+
+    # install Inkycal
+    pip3 install -e ./
+
+Creating settings file
+----------------------
+coming soon