39 lines
947 B
Markdown
39 lines
947 B
Markdown
# 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
|
|
* From: https://github.com/nlohmann/json
|
|
* Version: 3.12.0
|
|
|
|
### HTTPlib
|
|
* From: https://github.com/yhirose/cpp-httplib
|
|
* Version: 0.47.0
|
|
|
|
# Info on TRMNL API
|
|
* https://github.com/usetrmnl/trmnl-firmware
|