# rust-template-generated-bin

[![maintenance status: passively-maintained](https://img.shields.io/badge/maintenance-passively--maintained-yellowgreen.svg)](https://doc.rust-lang.org/cargo/reference/manifest.html#the-badges-section)
[![license: MIT OR APACHE-2.0](https://img.shields.io/crates/l/rust-template-generated-bin.svg)](#license)
[![crates.io](https://img.shields.io/crates/v/rust-template-generated-bin.svg)](https://crates.io/crates/rust-template-generated-bin)
[![docs.rs](https://docs.rs/rust-template-generated-bin/badge.svg)](https://docs.rs/rust-template-generated-bin/)
[![rust 1.59.0+ badge](https://img.shields.io/badge/rust-1.59.0+-93450a.svg)](https://doc.rust-lang.org/cargo/reference/manifest.html#the-rust-version-field)
[![Rust CI](https://github.com/gifnksm/rust-template-generated-bin/actions/workflows/ci.yml/badge.svg)](https://github.com/gifnksm/rust-template-generated-bin/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/gifnksm/rust-template-generated-bin/graph/badge.svg)](https://codecov.io/gh/gifnksm/rust-template-generated-bin)

Example project generated by gifnksm/rust-tmeplate

## Installation

There are multiple ways to install rust-template-generated-bin.
Choose any one of the methods below that best suits your needs.

### Pre-built binaries

Executable binaries are available for download on the [GitHub Release page].

[GitHub Release page]: https://github.com/gifnksm/rust-template-generated-bin/releases/

### Build from source using Rust

To build rust-template-generated-bin executable from the source, you must have the Rust toolchain installed.
To install the rust toolchain, follow [this guide](https://www.rust-lang.org/tools/install).

Once you have installed Rust, the following command can be used to build and install rust-template-generated-bin:

```console
# Install released version
$ cargo install rust-template-generated-bin

# Install latest version
$ cargo install --git https://github.com/gifnksm/rust-template-generated-bin.git rust-template-generated-bin
```

## Minimum supported Rust version (MSRV)

The minimum supported Rust version is **Rust 1.59.0**.
At least the last 3 versions of stable Rust are supported at any given time.

While a crate is a pre-release status (0.x.x) it may have its MSRV bumped in a patch release.
Once a crate has reached 1.x, any MSRV bump will be accompanied by a new minor version.

## License

This project is licensed under either of

* Apache License, Version 2.0
   ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
* MIT license
   ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)

at your option.

## Contribution

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](CONTRIBUTING.md).