Commit 9209de5f authored by willem's avatar willem
Browse files

Added README

parent 33367594
CRaft
=====
What?
-----
C implementation of the Raft Consensus protocol, BSD licensed
How does it work?
-----------------
See raft.h for full documentation.
Networking is out of scope for this project. The implementor will need to do all the plumbing. *Currently*, this is done by:
1) Implementing all the callbacks within raft_cbs_t.
2) Calling raft_recv_.* functions with msg_.* message structs
Dependencies
------------
There are no dependencies, however https://github.com/willemt/CLinkedListQueue is required for testing.
Building
--------
$make
Todo
----
- Member changes
- Log compaction
- More scenario tests (ie. more varied network partition scenarios)
- Usage example
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment