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

formatting

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

14
README.md
View file

@ -31,20 +31,20 @@ Cuprate is an effort to create an alternative [Monero](https://getmonero.org) no
It will be able to independently validate Monero consensus rules, providing a layer of security and redundancy for the Monero network.
<!-- TOOD: add some details about what Cuprate is and is not, goals, status -->
<!-- TODO: add some details about what Cuprate is and is not, goals, status -->
## Documentation
_Cuprate is currently a work-in-progress; documentation will be changing/unfinished._
Cuprate maintains various documentation books:
| Book | Description | Link |
|-----------------------------|------------------------------------------------------------|------|
| Cuprate's architecture book | Documents Cuprate's internal architecture & implementation | https://github.com/Cuprate/architecture-book
| Cuprate's protocol book | Documents the Monero protocol | https://github.com/Cuprate/monero-book
| Cuprate's user book | Practical user-guide for using `cuprated` | https://github.com/Cuprate/user-book
| 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 documentation, see the `cargo doc`s of the crates inside the [workspace](Cargo.toml), and the `README.md` files inside the crate's directory if applicable, for example: [`storage/cuprate-blockchain/README.md`](storage/cuprate-blockchain/README.md).
For crate (library) documentation, see the `Documentation` section in [`CONTRIBUTING.md`](CONTRIBUTING.md).
## Contributing
See [`CONTRIBUTING.md`](CONTRIBUTING.md).