This is the project workspace. Please refer to individual members for details:
The Rust compiler is required in order to build from source. Please follow the official Rust installation instructions.
The latest Stable version of Rust is required.
If you already have Rust installed, you may need to upgrade to the latest stable:
rustup update stable
You should also install the following to check whether the CI will pass
$ cargo make -V
=> cargo-make 0.24.1
$ cargo install --force cargo-make
$ cargo +nightly fmt -- -V
=> rustfmt 1.4.11-nightly (1838235 2019-12-03)
$ rustup toolchain install nightly
$ rustup component add rustfmt --toolchain nightly
The repository can be downloaded using Git:
git clone https://github.com/Charles-Johnson/zia_programming.git
To test all non-ignored tests:
cargo test
To test all tests in the documentation:
cargo test --doc
To test a specific test:
cargo test specific_test
To run a set of integration tests:
cargo test --test integration_test_filename
To generate API documentation:
cargo doc
You can then view ./target/doc/zia/index.html
in a web browser
To generate internal documentation:
cargo doc --document-private-items
In ./Cargo.toml
:
[package]
version = x.y.z
Then run in the terminal the following
git commit -a -m "Releasing zia-x.y.z"
git tag -a zia-x.y.z HEAD
cargo package
cargo publish
This software is licensed under the General Public License (GPL), version 3 (LICENSE http://www.gnu.org/licenses/gpl-3.0.en.html).