From a17ee3f500326ae7deec1c0a5067e3321ff5b9a1 Mon Sep 17 00:00:00 2001 From: xengineering Date: Fri, 11 Nov 2022 20:23:31 +0100 Subject: Document expected environment and dependencies --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 34ce504..b2b3584 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,20 @@ With Ceres you can run a recipe server in your home network. Have a look at the All notable changes are documented in the [changelog][2]. +## Expected environment and dependencies + +Ceres should run on every Linux distribution. If it does not run on your Linux +distribution, please contact me and we will see what we can do. + +Please install the following dependencies to build and run Ceres: + +- [GNU Coreutils][4] +- [Git][5] +- [Make][6] +- [Go][7] +- [MariaDB][3] + + ## Setup Ceres database Ceres supports only the [MariaDB][3] SQL implementation which is available on a @@ -105,3 +119,7 @@ executable at boot. [1]: https://xengineering.eu/git/ceres [2]: ./CHANGELOG.md [3]: https://mariadb.com/ +[4]: https://www.gnu.org/software/coreutils/ +[5]: https://git-scm.com/ +[6]: https://www.gnu.org/software/make/ +[7]: https://go.dev/ -- cgit v1.2.3-70-g09d2