README.md

slicec

To build slicec you must have Rust and Cargo installed. To install these, we recommend reading the following guide.

Building

Run the following command to build slicec and its dependencies:

cargo build

Running the tests

Run the following command to run the test suite:

cargo test

Generating documentation

To generate documentation for slicec, run the following command:

cargo doc --no-deps --document-private-items

This will generate documentation in the target/doc/ directory.

Additionally, you can easily view the documentation after generating it with the open flag:

cargo doc --no-deps --document-private-items --open