mirror of
https://github.com/TheCommsChannel/TC2-BBS-mesh.git
synced 2025-01-20 11:31:29 -05:00
Added section about CLI arguments to README.md
This commit is contained in:
parent
3a4a79928b
commit
7251f663e3
32
README.md
32
README.md
@ -90,11 +90,41 @@ If you're a Docker user, TC²-BBS Meshtastic is available on Docker Hub!
|
|||||||
Run the server with:
|
Run the server with:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
python server.py```
|
python server.py
|
||||||
```
|
```
|
||||||
|
|
||||||
Be sure you've followed the Python virtual environment steps above and activated it before running.
|
Be sure you've followed the Python virtual environment steps above and activated it before running.
|
||||||
|
|
||||||
|
## Command line arguments
|
||||||
|
```
|
||||||
|
$ python server.py --help
|
||||||
|
|
||||||
|
████████╗ ██████╗██████╗ ██████╗ ██████╗ ███████╗
|
||||||
|
╚══██╔══╝██╔════╝╚════██╗ ██╔══██╗██╔══██╗██╔════╝
|
||||||
|
██║ ██║ █████╔╝█████╗██████╔╝██████╔╝███████╗
|
||||||
|
██║ ██║ ██╔═══╝ ╚════╝██╔══██╗██╔══██╗╚════██║
|
||||||
|
██║ ╚██████╗███████╗ ██████╔╝██████╔╝███████║
|
||||||
|
╚═╝ ╚═════╝╚══════╝ ╚═════╝ ╚═════╝ ╚══════╝
|
||||||
|
Meshtastic Version
|
||||||
|
|
||||||
|
usage: server.py [-h] [--config CONFIG] [--interface-type {serial,tcp}] [--port PORT] [--host HOST] [--mqtt-topic MQTT_TOPIC]
|
||||||
|
|
||||||
|
Meshtastic BBS system
|
||||||
|
|
||||||
|
options:
|
||||||
|
-h, --help show this help message and exit
|
||||||
|
--config CONFIG, -c CONFIG
|
||||||
|
System configuration file
|
||||||
|
--interface-type {serial,tcp}, -i {serial,tcp}
|
||||||
|
Node interface type
|
||||||
|
--port PORT, -p PORT Serial port
|
||||||
|
--host HOST TCP host address
|
||||||
|
--mqtt-topic MQTT_TOPIC, -t MQTT_TOPIC
|
||||||
|
MQTT topic to subscribe
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Automatically run at boot
|
## Automatically run at boot
|
||||||
|
|
||||||
If you would like to have the script automatically run at boot, follow the steps below:
|
If you would like to have the script automatically run at boot, follow the steps below:
|
||||||
|
Loading…
Reference in New Issue
Block a user