mirror of
https://github.com/hinto-janai/cuprate.git
synced 2024-11-16 15:58:14 +00:00
Compare commits
3 commits
7ea53eb058
...
aa8d48c306
Author | SHA1 | Date | |
---|---|---|---|
|
aa8d48c306 | ||
|
b4ce7e0b57 | ||
|
1df755366b |
1 changed files with 13 additions and 9 deletions
22
README.md
22
README.md
|
@ -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).
|
||||
|
@ -51,4 +55,4 @@ Cuprate has a responsible vulnerability disclosure policy, see [`SECURITY.md`](S
|
|||
## License
|
||||
The `binaries/` directory is licensed under AGPL-3.0, everything else is licensed under MIT.
|
||||
|
||||
See [`LICENSE`](LICENSE) for more details.
|
||||
See [`LICENSE`](LICENSE) for more details.
|
||||
|
|
Loading…
Reference in a new issue