diff options
| author | xengineering <me@xengineering.eu> | 2024-05-01 16:23:53 +0200 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2024-05-01 16:23:53 +0200 |
| commit | 1d6a23f6307ea1a1225ca8b2f2b91f78d1323416 (patch) | |
| tree | 9104d8b4b110361fdddfc279352dcde7626db68c /README.md | |
| parent | ca4928a549251ad84c0ba2ef4179fa2174bbaabc (diff) | |
| download | ceres-1d6a23f6307ea1a1225ca8b2f2b91f78d1323416.tar ceres-1d6a23f6307ea1a1225ca8b2f2b91f78d1323416.tar.zst ceres-1d6a23f6307ea1a1225ca8b2f2b91f78d1323416.zip | |
Add usage instructions to README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
@@ -1,5 +1,23 @@ # Ceres - Recipe server for local networks +## Usage + +The `ceres` executable can be called without any arguments to start the server +with the default configuration `default_config.json`: + +``` +./ceres +``` + +A custom configuration can be passed with the `-c` flag: + +``` +./ceres -c path/to/custom_config.json +``` + +Further command line options are described in the help page which can be +retrieved by calling `./ceres -h`. + ## Build instructions The following build dependencies are required: |