From b2342b1b646d2de42433ea7857f0338d5e99949c Mon Sep 17 00:00:00 2001 From: nedko Date: Wed, 8 Jul 2026 14:51:04 +0300 Subject: [PATCH] Updated README --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d3feac8..9b66336 100644 --- a/README.md +++ b/README.md @@ -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