updated part of documentation

2020-11-24 00:35:12 +01:00
parent 2bfc9a2b4d
commit 4d65c9b601
6 changed files with 61 additions and 50 deletions
--- a/docs/quickstart.md
+++ b/docs/quickstart.md
@@ -0,0 +1,20 @@
+# Quickstart
+<img align="center" src="https://raw.githubusercontent.com/aceisace/Inky-Calendar/development/Gallery/logo.png" width="800">
+
+## Installing Inkycal
+
+Install inkycal  directly via the github repo:
+
+```bash
+# 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