mirror of
https://github.com/hinto-janai/cuprate.git
synced 2024-12-23 03:59:37 +00:00
1bc05366b0
Some checks failed
CI / fmt (push) Has been cancelled
CI / typo (push) Has been cancelled
CI / ci (macos-latest, stable, bash) (push) Has been cancelled
CI / ci (ubuntu-latest, stable, bash) (push) Has been cancelled
CI / ci (windows-latest, stable-x86_64-pc-windows-gnu, msys2 {0}) (push) Has been cancelled
* reduce cuprate banner size * update readme * update `SECURITY.md * formatting * readme: add todo * update license section * add user book, current about * formatting * formatting
2.4 KiB
2.4 KiB
Contents
About
Cuprate is an effort to create an alternative Monero node implementation in Rust.
It will be able to independently validate Monero consensus rules, providing a layer of security and redundancy for the Monero network.
Documentation
Cuprate is currently a work-in-progress; documentation will be changing/unfinished.
Cuprate maintains various documentation books:
Book | Description |
---|---|
Cuprate's architecture book | Documents Cuprate's internal architecture & implementation |
Cuprate's protocol book | Documents the Monero protocol |
Cuprate's user book | Practical user-guide for using cuprated |
For crate (library) documentation, see the Documentation
section in CONTRIBUTING.md
.
Contributing
See CONTRIBUTING.md
.
Security
Cuprate has a responsible vulnerability disclosure policy, see SECURITY.md
.
License
The binaries/
directory is licensed under AGPL-3.0, everything else is licensed under MIT.
See LICENSE
for more details.