summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2022-08-22 10:30:48 +0200
committerxengineering <me@xengineering.eu>2022-08-22 10:30:48 +0200
commitb461ff7cde65c438318d1c71b97f012ce99b7da8 (patch)
tree88ef067ca14066e350fc99a7e0a97bcef74232e1 /README.txt
parentfa1b081945cd013de7b005e8c66d5fa5726cc404 (diff)
downloadlimox-b461ff7cde65c438318d1c71b97f012ce99b7da8.tar
limox-b461ff7cde65c438318d1c71b97f012ce99b7da8.tar.zst
limox-b461ff7cde65c438318d1c71b97f012ce99b7da8.zip
Add documentation about dependencies
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt37
1 files changed, 24 insertions, 13 deletions
diff --git a/README.txt b/README.txt
index cde5a80..4590edd 100644
--- a/README.txt
+++ b/README.txt
@@ -8,6 +8,30 @@ The Linux on mobile XMPP (LimoX) client. It should be fast, compliant and
usable on mobile linux devices like smartphones or tablets.
+Building and dependencies
+-------------------------
+
+Install these build dependencies:
+
+- meson
+- ninja
+- gcc
+
+Install these runtime dependencies:
+
+- libstrophe
+- gtk4
+
+Just run these commands to build and run:
+
+ meson build
+ ninja -C build
+ ./build/limox
+
+Run `rm -r build` to clean the build folder. You can get a help page by running
+`./build/limox -h`.
+
+
Roadmap
-------
@@ -65,17 +89,4 @@ Roadmap
- [ ] XEP-0384: OMEMO Encryption
-Building
---------
-
-Just run these commands to build and run:
-
- meson build
- ninja -C build
- ./build/limox
-
-Run `rm -r build` to clean the build folder. You can get a help page by running
-`./build/limox -h`.
-
-
[1] https://xmpp.org/extensions/xep-0459.html