From 23311fe01119fea5403f77e67372603f59eb1937 Mon Sep 17 00:00:00 2001 From: xengineering Date: Fri, 11 Nov 2022 20:11:04 +0100 Subject: Document packaging and installation in README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index c79a647..34ce504 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,29 @@ 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 service unit for the init system of your distribution. + +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 [3]: https://mariadb.com/ -- cgit v1.2.3-70-g09d2