diff options
| -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: |