messenger-cli

Command-line user interface for GNUnet Messenger
Log | Files | Refs | README | LICENSE

README.md (2966B)

      1 # messenger-cli
      2 
      3 A CLI for the Messenger service of GNUnet.
      4 
      5 [![messenger-cli](https://snapcraft.io/messenger-cli/badge.svg)](https://snapcraft.io/messenger-cli)
      6 
      7 ```
      8                             
      9     o                   o   
     10   ooo                   oo  
     11      ooooo        ooooo     
     12          oo      ooo        
     13           oo    ooo         
     14            ooooooo          
     15            oooooo           
     16             oooo            
     17                             
     18 
     19 ```
     20 
     21 ![Overview of the application](screenshots/messenger.png "Overview of the application")
     22 
     23 ## Details
     24 
     25 The tool messenger-cli is an terminal interface for the GNUnet Messenger service. The goal is to provide private and secure communication between any group of devices.
     26 
     27 Chats will generally created as opt-in. So you can decide who may contact you directly and who does not, accepting to a direct chat. Leaving a chat is also always possible.
     28 
     29 ## Build & Installation
     30 
     31 The following dependencies are required and need to be installed to build the application:
     32 
     33  - [gnunet](https://git.gnunet.org/gnunet.git/): For using general GNUnet datatypes
     34  - [libgnunetchat](https://git.gnunet.org/libgnunetchat.git/): For chatting via GNUnet messenger
     35  - [ncurses](https://www.gnu.org/software/ncurses/): For the general UI visualization
     36  - [libsecret](https://gitlab.gnome.org/GNOME/libsecret): For storing and receiving secrets to encrypt/decrypt local keys
     37 
     38 Then you can simply use [Meson](https://mesonbuild.com/) as follows:
     39 ```
     40 meson setup build      # Configure the build files for your system
     41 ninja -C build         # Build the application using those build files
     42 ninja -C build install # Install the application
     43 ```
     44 
     45 Here is a list of some useful build commands using Meson and [Ninja](https://ninja-build.org/):
     46 
     47  - `meson compile -C build` to just compile everything with configured parameters
     48  - `rm -r build` to cleanup build files in case you want to recompile
     49  - `meson install -C build` to install the compiled files (you might need sudo privileges)
     50  - `meson dist -C build` to create a tar file for distribution
     51  - `ninja -C build uninstall` to uninstall a previous installation (you might need sudo privileges)
     52 
     53 If you want to change the installation location, use the `--prefix=` parameter in the initial meson command. Also you can enable optimized release builds by adding `--buildtype=release` as parameter.
     54 
     55 ## Contribution
     56 
     57 If you want to contribute to this project as well, the following options are available:
     58 
     59  - Contribute directly to the [source code](https://git.gnunet.org/messenger-cli.git/) with patches to fix issues, implement new features or improve the usability.
     60  - Open issues in the [bug tracker](https://bugs.gnunet.org/bug_report_page.php) to report bugs, issues or missing features.
     61  - Contact the authors of the software if you need any help to contribute (testing is always an option).
     62 
     63 The list of all previous authors can be viewed in the provided [file](AUTHORS).
     64