# Ceres - Recipe server for local networks

## 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