Lib.rs

cleanux is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install cleanux

It will make the cleanux command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall cleanux uninstalls.

Adding cleanux library as a dependency

Run this command in a terminal, in your project's directory:

cargo add cleanux

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

cleanux = "0.1.0"

The cleanux library will be automatically available globally. Read the cleanux library documentation.

Back to the crate overview.

---