From 61ceb54276f7f3e2ac9cdd9d4ada7ee9e2e5241e Mon Sep 17 00:00:00 2001 From: TheJackiMonster Date: Wed, 22 Dec 2021 11:58:44 +0100 Subject: Updated README.md with build instructions Signed-off-by: TheJackiMonster --- README.md | 34 +++++++++++++++++++++++++--------- 1 file 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 @@ A GTK based GUI for the Messenger service of GNUnet. -## (Planned) Dependencies - - - [gnunet](https://git.gnunet.org/gnunet.git/) - - [libgnunetchat](https://git.gnunet.org/libgnunetchat.git/) - - [gtk3](https://gitlab.gnome.org/GNOME/gtk) - - [libhandy](https://gitlab.gnome.org/GNOME/libhandy/) - - [libnotify](https://gitlab.gnome.org/GNOME/libnotify) - - [qrencode](https://github.com/fukuchi/libqrencode) - - [zbar](https://github.com/mchehab/zbar) +## Build & Installation + +The following dependencies are required and need to be installed to build the application: + + - [gnunet](https://git.gnunet.org/gnunet.git/): For using general GNUnet datatypes + - [libgnunetchat](https://git.gnunet.org/libgnunetchat.git/): For chatting via GNUnet messenger + - [gtk3](https://gitlab.gnome.org/GNOME/gtk): For the general UI design + - [libhandy](https://gitlab.gnome.org/GNOME/libhandy): For responsive UI widgets + - [libnotify](https://gitlab.gnome.org/GNOME/libnotify): For notifications + - [qrencode](https://github.com/fukuchi/libqrencode): For generating QR codes to share credentials + - [zbar](https://github.com/mchehab/zbar): For scanning QR codes via camera + +As 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. + +Here is the list of the used submodules: + + - [gnome-characters](https://gitlab.gnome.org/GNOME/gnome-characters): For the emoji picker + +Then you can simply use the provided Makefile as follows: + + - `make` to just compile everything with default parameters + - `make clean` to cleanup build files in case you want to recompile + - `make debug` to compile everything with debug parameters + - `make release` to compile everything with build optimizations enabled + - `make install` to install the compiled files (you might need sudo permissions to install) -- cgit v1.2.3