This is a project template intended to be used with the cargo generate command
to simplify the process of publishing a repository written in
Rust.
There are two main ways to install rust-template-test, as explained below:
The project can be installed using Cargo through the following steps:
- Install the Rust toolchain using the official guide.
- Run
cargo install --git https://github.com/subreme/rust-template-test --branch main
Alternatively, the compiled binaries can be found in the Releases page.
Assuming you have Cargo installed, the simplest way to use the template is to use the following command:
cargo generate --git https://github.com/subreme/rust-templateOnce the first command is run, a prompt will appear asking for the project's name. Once a name is selected, all placeholders in the project's files, outlined by double curly brackets, will be automatically replaced by their corresponding values.
After that, the only other prompt is your GitHub username, which can either be personal or belong to your organization. This is required in order to generate the correct link to your repository once it is uploaded.
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
See CONTRIBUTING.md.