neocomm/README.md

37 lines
2.0 KiB
Markdown
Raw Normal View History

2017-06-23 21:29:57 +00:00
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
-------------
2017-07-03 15:18:17 +00:00
This model moves further from the federated decentralization model, taking one closer to that of torrents with their peer discovery. There are three components to the network: nodes and directory nodes. All connected machines work as nodes, but only those that are not firewalled can function as directory nodes (nodes that other nodes can connect to). With this model the directory nodes would serve the functionality of trackers in a torrent system (those nodes that have enough uptime to be considered _directory servers_).
2017-06-23 21:29:57 +00:00
API Documentation
-----------------
_There is currently no API available._
Clients
-------
_There are currently no clients available._
Building
--------
2017-07-03 15:18:17 +00:00
To build this project you will need a C99 compatible compiler ([GCC](https://gcc.gnu.org/) is recommended) and the [CMake build system](https://cmake.org/). To build run the following commands from the root directory of the project.
2017-07-02 10:10:26 +00:00
```
$ cd build/
$ cmake ..
$ make
```
2017-07-03 15:18:17 +00:00
By default this will build a `release` build, if you require a debug build run the `cmake` command with the additional flag `-DCMAKE_BUILD_TYPE=debug`.
Contributing
------------
If you would like to contribute to the project please read over the [contribution guide](/CONTRIBUTING.md).
2017-06-23 21:29:57 +00:00
License
-------
2017-07-01 13:34:13 +00:00
This project, unless otherwise stated, is licensed under the terms & conditions of the [GNU Lesser General Public License version 3 or greater](/LICENSE).