35 lines
1.3 KiB
Markdown
35 lines
1.3 KiB
Markdown
NeoComm
|
|
=======
|
|
NeoComm is a completely decentralized and anti-censorship IRC replacement network. The objective of this network is to create a secure form of group instant communication similar to IRC but decentralizing the network, and as a consequence hindering censorship within the network and protecting the network's endurance against malevolent entities that may try to block access to the network.
|
|
|
|
This repository provides a library with interfaces by which you can access the network, which you are able to use in your own software under the terms & conditions of the [library's license](#license).
|
|
|
|
Network Model
|
|
-------------
|
|
|
|
API Documentation
|
|
-----------------
|
|
_There is currently no API available._
|
|
|
|
Clients
|
|
-------
|
|
_There are currently no clients available._
|
|
|
|
Building
|
|
--------
|
|
This project has a few dependencies necessary for proper functionality. Please install the following:
|
|
- CMake
|
|
|
|
To compile run the following commands:
|
|
```
|
|
$ cd build/
|
|
$ cmake ..
|
|
$ make
|
|
```
|
|
|
|
By default this will build a `release` build, if you require a debug build run the `cmake` command with the additional parameter `-DCMAKE_BUILD_TYPE=debug`.
|
|
|
|
License
|
|
-------
|
|
This project, unless otherwise stated, is licensed under the terms & conditions of the [GNU Lesser General Public License version 3 or greater](/LICENSE).
|