mirror of
https://github.com/TheCommsChannel/TC2-BBS-mesh.git
synced 2025-03-05 20:51:53 -08:00
update readme file
This commit is contained in:
parent
2e2408e546
commit
fb56870dd3
44
README.md
44
README.md
|
@ -14,7 +14,7 @@ If you're a Docker user, TC²-BBS Meshtastic is available on Docker Hub!
|
|||
|
||||
### Requirements
|
||||
|
||||
- Python 3.x
|
||||
- Python 3.12
|
||||
- Meshtastic
|
||||
- pypubsub
|
||||
|
||||
|
@ -36,33 +36,33 @@ If you're a Docker user, TC²-BBS Meshtastic is available on Docker Hub!
|
|||
cd TC2-BBS-mesh
|
||||
```
|
||||
|
||||
2. Set up a Python virtual environment:
|
||||
2. Set up a `Pyenv`
|
||||
|
||||
2.1 Follow instructions [here](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation).
|
||||
|
||||
2.2 Install Python 3.12
|
||||
|
||||
```sh
|
||||
python -m venv venv
|
||||
pyenv install 3.12
|
||||
```
|
||||
|
||||
3. Activate the virtual environment:
|
||||
2.3 Set your environment
|
||||
|
||||
- On Windows:
|
||||
```sh
|
||||
pyenv local 3.12
|
||||
```
|
||||
|
||||
3. Set up a `Poetry`
|
||||
|
||||
Follow instructions [here](https://python-poetry.org/docs/#installation).
|
||||
|
||||
4. Install the required packages
|
||||
|
||||
```sh
|
||||
venv\Scripts\activate
|
||||
poetry install
|
||||
```
|
||||
|
||||
- On macOS and Linux:
|
||||
|
||||
```sh
|
||||
source venv/bin/activate
|
||||
```
|
||||
|
||||
4. Install the required packages:
|
||||
|
||||
```sh
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
5. Rename `example_config.ini`:
|
||||
5. Rename `example_config.ini`
|
||||
|
||||
```sh
|
||||
mv example_config.ini config.ini
|
||||
|
@ -112,6 +112,7 @@ python server.py
|
|||
Be sure you've followed the Python virtual environment steps above and activated it before running.
|
||||
|
||||
## Command line arguments
|
||||
|
||||
```
|
||||
$ python server.py --help
|
||||
|
||||
|
@ -139,8 +140,6 @@ options:
|
|||
MQTT topic to subscribe
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Automatically run at boot
|
||||
|
||||
If you would like to have the script automatically run at boot, follow the steps below:
|
||||
|
@ -196,11 +195,13 @@ If you would like to have the script automatically run at boot, follow the steps
|
|||
2. **Viewing Logs**
|
||||
|
||||
Viewing past logs:
|
||||
|
||||
```sh
|
||||
journalctl -u mesh-bbs.service
|
||||
```
|
||||
|
||||
Viewing live logs:
|
||||
|
||||
```sh
|
||||
journalctl -u mesh-bbs.service -f
|
||||
```
|
||||
|
@ -210,6 +211,7 @@ If you would like to have the script automatically run at boot, follow the steps
|
|||
Note: There have been reports of issues with some device roles that may allow the BBS to communicate for a short time, but then the BBS will stop responding to requests.
|
||||
|
||||
The following device roles have been working:
|
||||
|
||||
- **Client**
|
||||
- **Router_Client**
|
||||
|
||||
|
|
Loading…
Reference in a new issue