Skip to content
/ ramen Public

Raft Consensus Algorithm Coupled With an IEEE 802.11 Based Mesh Network for Embedded Systems

License

Notifications You must be signed in to change notification settings

A5-015/ramen

Repository files navigation

ramen logo

ramen: Raft Consensus on Mesh Network

See the wiki page for further details.

ramen API

Full documentation can be found here.

Development Setup Instructions

  • Make sure to initialize the submodules
    • git submodule update --init --recursive
  • Install Docker, Clang, ClangFormat, Clang-Tidy
    • sudo apt install docker.io clang clang-format clang-tidy
  • Install PlatformIO, Black, Pylint
    • pip install platformio black pylint
  • Open the repository in Visual Studio Code
  • Install the recommended extensions for the project, a box will popup on lower left corner
  • That's it!

Licencing

This project is published under GNU GPLv3 License and the ramen logo was adapted from icons made by Freepik from www.flaticon.com