diff --git a/README b/README deleted file mode 100644 index 1273ae6..0000000 --- a/README +++ /dev/null @@ -1,30 +0,0 @@ -Meshview -======== - -Now running at https://meshview.bayme.sh - -This project watches a MQTT topic for meshtastic messages, imports them to a -database and has a web UI to view them. -Requires Python 3.12 - -Running -------- -$ python3 -m venv env -$ ./env/bin/pip install -r requirements.txt -$ ./env/bin/python main.py - -You also need to install: - sudo apt-get install graphviz (may be added to requirements.txt?) - -Now you can hit http://localhost/ - -Other Options: ---port - Web server port, default is 80 - ---mqtt-server - MQTT Server, default is mqtt.bayme.sh - ---topic - MQTT Topic, default is 'msh/US/bayarea/#' - diff --git a/README.md b/README.md new file mode 100644 index 0000000..bfb8c9b --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +Meshview +======== + +Now running at https://meshview.bayme.sh + +This project watches a MQTT topic for meshtastic messages, imports them to a +database and has a web UI to view them. +Requires Python 3.12 + +Running +------- +Clone the repo from github with: +``` bash +git clone --recurse-submodules https://github.com/pablorevilla-meshtastic/meshview.git +``` +It is important to include the `--recurse-submodules` flag or the meshtastic protobufs wont be included + +Create a python virtual environment: +``` bash +cd meshview +python3 -m venv env +``` +Install the environment requirements: +``` bash +./env/bin/pip install -r requirements.txt +``` +You also need to install `graphviz`: +``` bash +sudo apt-get install graphviz +``` + +To run Meshview: +``` bash +./env/bin/python main.py +``` +Now you can hit http://localhost/ + +Other Options: +* `--port` + + Web server port, default is `8081` + +* `--mqtt-server` + + MQTT Server, default is `mqtt.bayme.sh` + +* `--topic` + + MQTT Topic, default is `msh/US/bayarea/#` +