nedko/trmnl_server_cpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
nedko
2026-07-08 14:51:04 +03:00
parent b9ed4fa76a
commit b2342b1b64
1 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -1,15 +1,29 @@
# Required packages for building (Ubuntu 24.04) # Building
### Required packages for building (Ubuntu 24.04)
`build-essential` `build-essential`
### Build
Use `make` to build the executable.
# Usage # Usage
### Configuration ### Configuration
Use file named `config.json` in working directory or supply your own via first argument. Use file named `config.json` in working directory or supply your own via first argument.
For configuration example see `config_example.json`. For configuration example see `config_example.json`.
### Devices ### Devices
Use file named `devices.json` in working directory or supply your own via configuration file. Use file named `devices.json` in working directory or supply your own via configuration file.
For example see `devices_example.json`.
**Note: This file will be managed by the server when devices successfully register.** **Note: This file will be managed by the server when devices successfully register.**
### Running
You can start the server via `./server` after building.
You can start the server headless via `nohup ./server > log.txt &`.
This will also redirect the server log to `log.txt`
# Libraries # Libraries
### JSON ### JSON