feat: add documentation, enable makefile driven usage

This introduces a One-Stop-Shop Makefile.

Also brings back tensorflow as dependency, it is still needed
This commit is contained in:
Daniel Molkentin
2024-09-10 20:34:37 +02:00
committed by drbacke
parent c9bf0ecd36
commit e54f14bea1
4 changed files with 92 additions and 4 deletions

View File

@@ -20,14 +20,33 @@ https://www.akkudoktor.net/forum/diy-energie-optimierungssystem-opensource-proje
- `Backend:` Visual Cleaner (z.B. E-Auto Akku = 100%, dann sollte die Lademöglichkeit auf 0 stehen. Zumindest bei der Ausgabe sollte das "sauber" sein)
- `Backend:` Cache regelmäßig leeren können (API)
## Installation
Gute Install Anleitung:
https://meintechblog.de/2024/09/05/andreas-schmitz-joerg-installiert-mein-energieoptimierungssystem/
Das Projekt erfordert Python 3.8 oder neuer. Alle notwendigen Abhängigkeiten können über `pip` installiert werden. Klonen Sie das Repository und installieren Sie die erforderlichen Pakete mit:
Das Projekt erfordert Python 3.8 oder neuer.
### Schnellanleitung
Unter Linux (Ubuntu/Debian):
```bash
sudo apt install make
```
Unter Macos (benötigt [Homebrew](https://brew.sh)):
```zsh
brew install make
```
Nun `config.example.py` anpassen und dann in `config.py` umbennenen. Anschließend kann der Server über `make run` gestartet werden.
Eine vollständige Übersicht über die wichtigsten Kurzbefehle gibt `make help`.
### Ausführliche Anleitung
Alle notwendigen Abhängigkeiten können über `pip` installiert werden. Klonen Sie das Repository und installieren Sie die erforderlichen Pakete mit:
```bash
git clone https://github.com/Akkudoktor-EOS/EOS