Updated README

This commit is contained in:
2026-07-08 14:51:04 +03:00
parent b9ed4fa76a
commit b2342b1b64

View File

@@ -1,15 +1,29 @@
# Required packages for building (Ubuntu 24.04)
# Building
### Required packages for building (Ubuntu 24.04)
`build-essential`
### Build
Use `make` to build the executable.
# Usage
### Configuration
Use file named `config.json` in working directory or supply your own via first argument.
For configuration example see `config_example.json`.
### Devices
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.**
### 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
### JSON