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

Compare commits

base: SyntheticBird:7ea53eb0586183f39c67e5c1188077a64cdb3923
Branches Tags
SyntheticBird:main
SyntheticBird:json
SyntheticBird:book
SyntheticBird:cast
SyntheticBird:benches
SyntheticBird:blockchain-benches
SyntheticBird:codeowners
SyntheticBird:rpc-types-benches
SyntheticBird:helper-bench
SyntheticBird:db-bench
SyntheticBird:cryptonight-bench
SyntheticBird:rpc-handler-json
SyntheticBird:rpc-types
SyntheticBird:db
SyntheticBird:lychee
SyntheticBird:json-rpc-bench
SyntheticBird:user-book
SyntheticBird:storage
SyntheticBird:issue
SyntheticBird:tracing
SyntheticBird:test
SyntheticBird:bin
SyntheticBird:cuprate-p2p
SyntheticBird:db-v0.2
...
compare: SyntheticBird:aa8d48c30677515ae48f52d8bb462a4ccbbf0706
Branches Tags
SyntheticBird:json
SyntheticBird:book
SyntheticBird:cast
SyntheticBird:main
SyntheticBird:benches
SyntheticBird:blockchain-benches
SyntheticBird:codeowners
SyntheticBird:rpc-types-benches
SyntheticBird:helper-bench
SyntheticBird:db-bench
SyntheticBird:cryptonight-bench
SyntheticBird:rpc-handler-json
SyntheticBird:rpc-types
SyntheticBird:db
SyntheticBird:lychee
SyntheticBird:json-rpc-bench
SyntheticBird:user-book
SyntheticBird:storage
SyntheticBird:issue
SyntheticBird:tracing
SyntheticBird:test
SyntheticBird:bin
SyntheticBird:cuprate-p2p
SyntheticBird:db-v0.2

3 commits
7ea53eb058 ... aa8d48c306

Author SHA1 Message Date
hinto.janai
aa8d48c306
formatting 2024-06-13 15:09:49 -04:00
hinto.janai
b4ce7e0b57
formatting 2024-06-13 15:02:03 -04:00
hinto.janai
1df755366b
add user book, current about 2024-06-13 14:57:55 -04:00
1 changed files with 13 additions and 9 deletions
Show stats Expand all files Collapse all files

20
README.md
View file

@ -18,29 +18,33 @@ _(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).
The project is currently a work-in-progress.
It will be able to independently validate Monero consensus rules, providing a layer of security and redundancy for the Monero network.
<!-- TODO: 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)
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).
| Book | Description |
|-----------------------------------------------------------------|------------------------------------------------------------|
| [Cuprate's architecture book](https://architecture.cuprate.org) | Documents Cuprate's internal architecture & implementation |
| [Cuprate's protocol book](https://monero-book.cuprate.org) | Documents the Monero protocol |
| [Cuprate's user book](https://user.cuprate.org) | Practical user-guide for using `cuprated` |
For crate (library) documentation, see the `Documentation` section in [`CONTRIBUTING.md`](CONTRIBUTING.md).
## Contributing
See [`CONTRIBUTING.md`](CONTRIBUTING.md).