blob: 378e62aae0493bee1ad6e30df1bd72c92f3c644d (
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
|
# Ceres
Ceres is a recipe server for local networks.
## Usage
The Ceres source code can be downloaded with [Git][2].
```
git clone https://cgit.xengineering.eu/ceres
cd ceres
git submodule update --init
```
Only the [Go][4] tool is required to build ceres.
```
go build
```
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.
```
./ceres
```
For development it is recommended to build and run it without producing an
executable, an activated race detector and injected examples.
```
go run --race ./... --examples
```
The help page (`./ceres --help`) contains further details.
## 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
[4]: https://go.dev
|
