diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 83 |
1 files changed, 0 insertions, 83 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index 3b21926..0000000 --- a/README.md +++ /dev/null @@ -1,83 +0,0 @@ - - -# Ceres - Recipe server for your favorite dishes - -With Ceres you can run a recipe server in your home network. Have a look at the -[project page][1] for more details. - -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] - - -## Build and run Ceres - -If you just cloned the repository it is important to initialize Git submodules -to add dependencies via `git submodule update --init`. - -Then it is time to build and run Ceres for the first time in debug mode like -this: - -``` - make debug -``` - -In addition you can also build the server executable with `make all`. The -result is in the build folder and can be run with: - -``` - ./build/ceres -c config/debug.json -``` - -The used `config/debug.json` config file is only for debugging. If you want to -run it as a server, have a look at the `config/default.json` file. - - -## Packaging and Installation - -If you want to package Ceres for a Linux distribution, feel free to use the -Make target for installation. Use it for example with a fakeroot: - -``` - mkdir fakeroot - make DESTDIR=fakeroot install - tree fakeroot -``` - -Please add a startup script or service unit for the init system of your -distribution. Furthermore create a system user to run the server and grant him -ownership to the data directory specified in the configuration file (default is -`/var/lib/ceres`): - -``` - useradd --system ceres - chown ceres:ceres /var/lib/ceres -``` - -If you want to install Ceres to your system, it is recommended to first do the -packaging. One reason is that there is no uninstall Make target. This would -have to be tested and package managers are way better in cleanly remove stuff -from your system. - -If you insist to install it without an uninstall option, run `make install` -with root rights and write a service unit or something else to run the -executable at boot. - - -[1]: https://xengineering.eu/git/ceres -[2]: ./CHANGELOG.md -[4]: https://www.gnu.org/software/coreutils/ -[5]: https://git-scm.com/ -[6]: https://www.gnu.org/software/make/ -[7]: https://go.dev/ |