diff options
| author | xengineering <me@xengineering.eu> | 2024-05-01 16:14:04 +0200 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2024-05-01 16:16:08 +0200 |
| commit | ae0cbafb0202355973572e208c75591d12c2250c (patch) | |
| tree | 7c77b8a8859b743c8ee51ab3a8a426a728368af4 /README.md | |
| parent | 07f011bbbb22de9e7b4fd4af30fa0a92ee25b6d8 (diff) | |
| download | ceres-ae0cbafb0202355973572e208c75591d12c2250c.tar ceres-ae0cbafb0202355973572e208c75591d12c2250c.tar.zst ceres-ae0cbafb0202355973572e208c75591d12c2250c.zip | |
Add build instructions to README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
@@ -1,5 +1,24 @@ # 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 @@ -12,3 +31,6 @@ define a "public API". These aspects of Ceres together form the public API: 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 |