summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2022-11-11 20:11:04 +0100
committerxengineering <me@xengineering.eu>2022-11-11 20:11:04 +0100
commit23311fe01119fea5403f77e67372603f59eb1937 (patch)
treeca275bac1aa3576ce81b9a40621d28ada914572d /README.md
parentd6da536c19230349d7ef8ce71cce50c13a992574 (diff)
downloadceres-23311fe01119fea5403f77e67372603f59eb1937.tar
ceres-23311fe01119fea5403f77e67372603f59eb1937.tar.zst
ceres-23311fe01119fea5403f77e67372603f59eb1937.zip
Document packaging and installation in README
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
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/