bassmaster187 / TeslaLogger

TeslaLogger is a self hosted data logger for your Tesla Model S/3/X/Y. Actually it supports RaspberryPi 3B, 3B+, 4B, Docker and Synology NAS.
https://www.teslalogger.de
GNU General Public License v3.0
516 stars 170 forks source link

Consolidate/reorganize readme files #794

Open Adminius opened 2 years ago

Adminius commented 2 years ago

Today we have a lot of readme files, that are spread into different locations:

https://github.com/bassmaster187/TeslaLogger/blob/master/README.md https://github.com/bassmaster187/TeslaLogger/blob/master/Teslamate-Import/README.md https://github.com/bassmaster187/TeslaLogger/blob/master/TeslaFi-Import/README.md https://github.com/bassmaster187/TeslaLogger/blob/master/srtm/README.md

https://github.com/bassmaster187/TeslaLogger/blob/master/backup_to_google_drive.md https://github.com/bassmaster187/TeslaLogger/blob/master/dashboard.md https://github.com/bassmaster187/TeslaLogger/blob/master/dev-howto.md https://github.com/bassmaster187/TeslaLogger/blob/master/docker_setup.md https://github.com/bassmaster187/TeslaLogger/blob/master/docker_setup_synology.md https://github.com/bassmaster187/TeslaLogger/blob/master/phpmyadmin-howto.md https://github.com/bassmaster187/TeslaLogger/blob/master/wallbox.md

https://github.com/bassmaster187/TeslaLogger/blob/master/docs/en/faq.md

https://github.com/bassmaster187/TeslaLogger/blob/master/TeslaLogger/Geofence.md https://github.com/bassmaster187/TeslaLogger/blob/master/TeslaLogger/WebServer.md

https://github.com/bassmaster187/TeslaLogger/blob/master/TeslaLogger/bin/changelog.md

and https://github.com/bassmaster187/TeslaLogger/blob/master/TeslaLogger/www/admin/Teslalogger.pdf https://github.com/bassmaster187/TeslaLogger/blob/master/TeslaLogger/www/admin/Teslalogger.odt

We have to try to place it (if possible) to one place with and maybe link it to each other.

we already have a folder docs. so we can try use it. Example: docs/how-to/readme.md -> this file links all other how-tos, e.g. dev-howto, phpmyadmin and so on.

other ideas?

bassmaster187 commented 2 years ago

basically a teslafi-import readme should be left where it is, but as you mention we should link them in a doc. @rowich do you have any progress on the docs?

Adminius commented 2 years ago

yeah, this 4 can't be moved, aber linked: https://github.com/bassmaster187/TeslaLogger/blob/master/README.md https://github.com/bassmaster187/TeslaLogger/blob/master/Teslamate-Import/README.md https://github.com/bassmaster187/TeslaLogger/blob/master/TeslaFi-Import/README.md https://github.com/bassmaster187/TeslaLogger/blob/master/srtm/README.md