Add Makefile and Markdown linter (#73)

* Add Makefile

* Update .gitignore to exclude venv

* Add requirements.txt for venv

* Add pymarkdown lint Github action

* Update .md from lint tool

* Update README with make commands

* Add linter config
This commit is contained in:
Adriaan Van Niekerk
2025-10-31 01:06:36 +02:00
committed by GitHub
parent bbe3bd79db
commit 0cd98c67e2
44 changed files with 524 additions and 279 deletions

View File

@@ -11,8 +11,6 @@ This is the main purpose of this device. It returns the converted image as a num
Details can be found here: tbd
## Picture Server
```http://IP-ESP32/capture```
@@ -23,8 +21,6 @@ This is a implementation of the camera interface of https://github.com/jomjol/wa
It is fully compatible including the parameters (```quality```=..., `size=...` ) . This allows to use this ESP32 system in parallel to the corresponding docker system: https://github.com/jomjol/water-meter-system-complete, from which this project is basically the successor.
## File server
Access: ```http://IP-ESP32/fileserver/```
@@ -35,16 +31,12 @@ The usage is self explaining. The file path or file can directly be accessed by
Example for ```config.ini``` : ```http://IP-ESP/fileserver/config/config.ini```
## OTA-Update
```http://IP-ESP32/ota?file=firmware.bin```
Here an over the air update can be triggered. The firmware file is expected to be located in the sub directory ```/firmware/``` and can be uploaded with the file server. By the parameter ```file``` the name of the firmware file needs to be given.
## Reboot
```http://IP-ESP32/reboot```
@@ -53,8 +45,6 @@ A reboot with a delay of 5 seconds is initiated, e.g. after firmware update.
**ATTENTION**: currently this is not working properly - hardware power off is needed instead. **Work in progress!**
## Simple Web Server
If none of the above URLs are fitting, a very simple web server checks, if there is a fitting file from the sub directory ```/html```