diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 |
1 files changed, 20 insertions, 23 deletions
@@ -1,42 +1,40 @@ -# Ceres - Recipe server for local networks +# Ceres + +Ceres is a 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`: +The Ceres source code can be downloaded with [Git][2]. ``` -./ceres +git clone https://cgit.xengineering.eu/ceres +cd ceres +git submodule update --init ``` -A custom configuration can be passed with the `-c` flag: +Only the [Go][4] tool is required to build ceres. ``` -./ceres -c path/to/custom_config.json +go build ``` -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: +The resulting `ceres` executable can be run with the embedded default +configuration. It produces a `storage` folder containing the SQLite3 database. +The storage directory is set in the configuration file. See +`default_config.json` for a reference. -- [Git][2] -- [Go][4] -- [GNU Make][3] +``` +./ceres +``` -On Linux Ceres can be build like this: +For development it is recommended to build and run it without producing an +executable, an activated race detector and injected examples. ``` -git clone https://cgit.xengineering.eu/ceres -cd ceres -git submodule update --init -make +go run --race ./... --examples ``` -The `ceres` executable is placed in the `build` folder which can be removed by -calling `make clean`. +The help page (`./ceres --help`) contains further details. ## API definition for Semantic Versioning @@ -52,5 +50,4 @@ As soon as version 1.0.0 is reached these aspects are stable. [1]: https://semver.org [2]: https://git-scm.com -[3]: https://www.gnu.org/software/make [4]: https://go.dev |