Diffstat (limited to 'README.md')
1 files changed, 48 insertions, 1 deletions
@@ -1,3 +1,50 @@
-A client-side library for applications to use the Messenger service of GNUnet.
+A client-side library for applications to utilize the Messenger service of GNUnet.
+This library is an abstraction layer using the client API from different [GNUnet](https://www.gnunet.org) services to provide the functionality of a typical messenger application. The goal is to make developing such applications easier and independent of the GUI toolkit. So people can develop different interfaces being compatible with eachother despite visual differences, a few missing features or differences in overall design.
+Implementing all those typical features of a messenger application requires more than only a service to exchange messages. Therefore this library utilizes multiple different services provided by GNUnet to achieve this goal:
+ - [ARM](https://docs.gnunet.org/handbook/gnunet.html#Automatic-Restart-Manager-_0028ARM_0029) to automatically start all required services without manual setup from a user
+ - [FS](https://docs.gnunet.org/handbook/gnunet.html#File_002dsharing-_0028FS_0029-Subsystem) to upload, download and share files via the network in a secure way
+ - [GNS](https://docs.gnunet.org/handbook/gnunet.html#GNU-Name-System-_0028GNS_0029) to resolve published records of open lobbies, potentially exchanging contact credentials and opening a chat
+ - [IDENTITY](https://docs.gnunet.org/handbook/gnunet.html#IDENTITY-Subsystem) to create, delete and manage accounts as well as providing information to verify another users identity
+ - [MESSENGER](https://docs.gnunet.org/handbook/gnunet.html#MESSENGER-Subsystem) to open, close and manage any kind of chats as well as exchanging messages in a decentralized and secure way with other users
+ - [NAMESTORE](https://docs.gnunet.org/handbook/gnunet.html#NAMESTORE-Subsystem) to store contact and group chat information locally and to publish records of lobbies accessible via GNS
+ - [REGEX](https://docs.gnunet.org/handbook/gnunet.html#REGEX-Subsystem) to publish peer information allowing other peers to quickly form a public group chat around a certain topic
+## Build & Installation
+The following dependencies are required and need to be installed to build the library:
+ - [gnunet](https://git.gnunet.org/gnunet.git/): For using GNUnet services and its datatypes
+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)
+ - `make docs` to build Doxygen documentation ([Doxygen](https://www.doxygen.nl/index.html) is required to do that)
+ - `make check` to test the library with automated unit tests ([Check](https://libcheck.github.io/check/) is required to do that)
+If you want to contribute to this project as well, the following options are available:
+ * Contribute directly to the [source code](https://git.gnunet.org/libgnunetchat.git/) with patches to fix issues or provide new features.
+ * Open issues in the [bug tracker](https://bugs.gnunet.org/bug_report_page.php) to report bugs, issues or missing features.
+ * Contact the authors of the software if you need any help to contribute (testing is always an option).
+The list of all previous authors can be viewed in the provided [file](AUTHORS).
+There are a few applications using this library already. So users can choose from any of them picking their favourite interface for messaging:
+ * [Messenger-GTK](https://git.gnunet.org/messenger-gtk.git/): A GTK based GUI for the Messenger service of GNUnet.
+ * [messenger-cli](https://git.gnunet.org/messenger-cli.git): A CLI for the Messenger service of GNUnet.