aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 25 insertions, 9 deletions
diff --git a/README.md b/README.md
index bb12f5c..eeec665 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,28 @@
2 2
3A GTK based GUI for the Messenger service of GNUnet. 3A GTK based GUI for the Messenger service of GNUnet.
4 4
5## (Planned) Dependencies 5## Build & Installation
6 6
7 - [gnunet](https://git.gnunet.org/gnunet.git/) 7The following dependencies are required and need to be installed to build the application:
8 - [libgnunetchat](https://git.gnunet.org/libgnunetchat.git/) 8
9 - [gtk3](https://gitlab.gnome.org/GNOME/gtk) 9 - [gnunet](https://git.gnunet.org/gnunet.git/): For using general GNUnet datatypes
10 - [libhandy](https://gitlab.gnome.org/GNOME/libhandy/) 10 - [libgnunetchat](https://git.gnunet.org/libgnunetchat.git/): For chatting via GNUnet messenger
11 - [libnotify](https://gitlab.gnome.org/GNOME/libnotify) 11 - [gtk3](https://gitlab.gnome.org/GNOME/gtk): For the general UI design
12 - [qrencode](https://github.com/fukuchi/libqrencode) 12 - [libhandy](https://gitlab.gnome.org/GNOME/libhandy): For responsive UI widgets
13 - [zbar](https://github.com/mchehab/zbar) 13 - [libnotify](https://gitlab.gnome.org/GNOME/libnotify): For notifications
14 - [qrencode](https://github.com/fukuchi/libqrencode): For generating QR codes to share credentials
15 - [zbar](https://github.com/mchehab/zbar): For scanning QR codes via camera
16
17As additional step you will need to load all required git submodules via `git submodule init` and `git submodule update`. It is also possible to just add the `--recursive` flag while cloning the repository to do that automatically.
18
19Here is the list of the used submodules:
20
21 - [gnome-characters](https://gitlab.gnome.org/GNOME/gnome-characters): For the emoji picker
22
23Then you can simply use the provided Makefile as follows:
24
25 - `make` to just compile everything with default parameters
26 - `make clean` to cleanup build files in case you want to recompile
27 - `make debug` to compile everything with debug parameters
28 - `make release` to compile everything with build optimizations enabled
29 - `make install` to install the compiled files (you might need sudo permissions to install)