initial docs

This commit is contained in:
Ace
2023-06-03 15:53:45 +02:00
parent bceec6d1e7
commit 8a81cd5908
125 changed files with 13090 additions and 0 deletions

View File

@@ -0,0 +1,23 @@
# Quickstart
<img align="center" src="https://github.com/aceisace/Inkycal/raw/assets/Repo/logo.png" width="800">
## Installing Inkycal
Install inkycal directly via the GitHub repo:
```bash
# clone the repo
git clone https://github.com/aceinnolab/Inkycal
# go to downloaded repo folder
cd Inkycal
# install Inkycal
pip3 install -e ./
```
## Creating settings file
Please navigate to the [WEB-UI](https://aceisace.eu.pythonanywhere.com/index) to create your settings file.
Copy the generated settings file to the Raspberry Pi
more coming soon..