ri2p
Rust implementation of the i2p client/server/router protocols
Status
Common Commands
-
cargo build
: Builds the ri2p binary -
cargo run
: Runs the ri2p binary -
cargo test
: Runs all test functions, in the ./tests directory, that contain the #[test] attribute -
cargo doc [--open]
: Builds the automatically generated ri2p Rust documentation, and optionally opens it in a web browser -
cargo fmt
: Standard formatter for Rust codestyle -
cargo clippy [--fix]
: Standard linter for Rust, and optionally will automatically fix linted issues -
mdbook build
: Builds the ri2p mdbook locally -
mdbook serve
: Serves the ri2p mdbook at http://localhost:3000, and rebuilds it on changes
CI/CD Information
GitHub is the central CI/CD platform for the ri2p project. CI/CD will occur only when modifications are made (pull-requests) to the master branch.
Additional Important Information
- Code of Conduct Guidelines
- Contributing Guidelines
- Open Source License
- Security (Vulnerability) Policy
- Major Authors & Contributors
- Changelog (SemVer & Timestamps)
Developers
If you would like to work on this project, please feel free to check the ri2p Project Kanban board for a list of the current items that we need to be worked on. If you would like to work on any of them, please contact ri2p in the discussions area and I will mark a task for you.
Documentation
Developers can find documentation for ri2p in the docs/ directory, or hosted online at ri2p.com.
The cargo doc
documentation that is automatically generated by Cargo can be viewed by running cargo doc --open
, or hosted online at ri2p.com/doc/doc/ri2p.