diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 |
1 files changed, 39 insertions, 4 deletions
| @@ -2,8 +2,43 @@ | |||
| 2 | 2 | ||
| 3 | A CLI for the Messenger service of GNUnet. | 3 | A CLI for the Messenger service of GNUnet. |
| 4 | 4 | ||
| 5 | ## (Planned) Dependencies | 5 | ``` |
| 6 | |||
| 7 | o o | ||
| 8 | ooo oo | ||
| 9 | ooooo ooooo | ||
| 10 | oo ooo | ||
| 11 | oo ooo | ||
| 12 | ooooooo | ||
| 13 | oooooo | ||
| 14 | oooo | ||
| 15 | |||
| 16 | |||
| 17 | ``` | ||
| 18 | |||
| 19 | ## Build & Installation | ||
| 20 | |||
| 21 | The following dependencies are required and need to be installed to build the application: | ||
| 22 | |||
| 23 | - [gnunet](https://git.gnunet.org/gnunet.git/): For using general GNUnet datatypes | ||
| 24 | - [libgnunetchat](https://git.gnunet.org/libgnunetchat.git/): For chatting via GNUnet messenger | ||
| 25 | - [ncurses](https://www.gnu.org/software/ncurses/): For the general UI visualization | ||
| 26 | |||
| 27 | Then you can simply use the provided Makefile as follows: | ||
| 28 | |||
| 29 | - `make` to just compile everything with default parameters | ||
| 30 | - `make clean` to cleanup build files in case you want to recompile | ||
| 31 | - `make debug` to compile everything with debug parameters | ||
| 32 | - `make release` to compile everything with build optimizations enabled | ||
| 33 | - `make install` to install the compiled files (you might need sudo permissions to install) | ||
| 34 | |||
| 35 | ## Contribution | ||
| 36 | |||
| 37 | If you want to contribute to this project as well, the following options are available: | ||
| 38 | |||
| 39 | - 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. | ||
| 40 | - Open issues in the [bug tracker](https://bugs.gnunet.org/bug_report_page.php) to report bugs, issues or missing features. | ||
| 41 | - Contact the authors of the software if you need any help to contribute (testing is always an option). | ||
| 42 | |||
| 43 | The list of all previous authors can be viewed in the provided [file](AUTHORS). | ||
| 6 | 44 | ||
| 7 | - [gnunet](https://git.gnunet.org/gnunet.git/) | ||
| 8 | - [libgnunetchat](https://git.gnunet.org/libgnunetchat.git/) | ||
| 9 | - [ncurses](https://www.gnu.org/software/ncurses/) | ||