SyntheticBird/cuprate-hinto-janai
1
0
Fork 0
mirror of https://github.com/hinto-janai/cuprate.git synced 2024-11-16 15:58:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

add user book, current about

Browse source
This commit is contained in:
hinto.janai 2024-06-13 14:57:55 -04:00
parent 7ea53eb058
commit 1df755366b
No known key found for this signature in database
GPG key ID: D47CE05FA175A499
1 changed files with 4 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -18,27 +18,26 @@ _(work-in-progress)_
<!--
TODO: add these sections someday.
- [Status](#status) // when we're near v1.0.0
- [Getting help](#getting-help) // issue tracker, user book, matrix channels, etc
- [Build](#build)
- [Windows](#windows)
- [macOS](#macOS)
- [Linux](#Linux)
-->
## About
Cuprate is an alternative [Monero](https://getmonero.org) node implementation, written in [Rust](http://rust-lang.org).
Cuprate is an effort to create an alternative [Monero](https://getmonero.org) node implementation in [Rust](http://rust-lang.org). It will be able to independently validate Monero consensus rules, providing a layer of security and redundancy for the Monero network.
The project is currently a work-in-progress.
<!-- TOOD: add some details about what Cuprate is and is not, goals, status -->
## Documentation
_Note that Cuprate is currently a work-in-progress; documentation will be changing/unfinished._
_Cuprate is currently a work-in-progress; documentation will be changing/unfinished._
Cuprate maintains various documentation books:
- [Cuprate's architecture book](https://github.com/Cuprate/architecture-book)
- [Cuprate's protocol book](https://github.com/Cuprate/monero-book)
- [Cuprate's user book](https://github.com/Cuprate/user-book)
For crate documentation, see the `cargo doc`s of the crates inside the [workspace](Cargo.toml), and the `README.md` inside the crate's directory if applicable, for example: [`storage/cuprate-blockchain/README.md`](storage/cuprate-blockchain/README.md).