blob: c4a12d7669ae10c02369e6f47b39035cf9acce96 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
# 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:
- [Git][2]
- [Go][4]
- [GNU Make][3]
On Linux Ceres can be build like this:
```
git clone https://cgit.xengineering.eu/ceres
cd ceres
make
```
The `ceres` executable is placed in the `build` folder which can be removed by
calling `make clean`.
## API definition for Semantic Versioning
Ceres uses Semantic Versioning as defined by [semver.org][1]. This requires to
define a "public API". These aspects of Ceres together form the public API:
- command line interface
- HTTP interface
- data storage format
- configuration file format and structure
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
|
