https://github.com/shadawck/cargo-basic-template
A basic template for rust crates. Use this template with "cargo generate".
https://github.com/shadawck/cargo-basic-template
cargo-generate rust-template template template-repository
Last synced: about 2 months ago
JSON representation
A basic template for rust crates. Use this template with "cargo generate".
- Host: GitHub
- URL: https://github.com/shadawck/cargo-basic-template
- Owner: shadawck
- Created: 2021-07-24T14:22:55.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-24T15:13:07.000Z (almost 5 years ago)
- Last Synced: 2025-01-15T22:24:40.123Z (over 1 year ago)
- Topics: cargo-generate, rust-template, template, template-repository
- Language: Rust
- Homepage: https://crates.io/crates/cargo-generate
- Size: 8.79 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# {{project-name}}
## Overview
**A brief description of the project !**
## Documentation
- [Examples Repository](./examples)
- [API Documentation](https://docs.rs/{{project-name}})
{% if crate_type == "bin" %}
## Installation
Using cargo :
```sh
cargo install {{project-name}}
```
or from source :
```sh
cargo install --git https://github.com/{{gituser}}/{{project-name}}
```
{% endif %}
## Example
First, add the dependency to your `cargo.toml`:
```toml
[dependencies]
{{crate_name}} = "0.1.0"
```
**Add first example here !**
### More example
- [Simple](./examples/firstexample.rs)
- [Other example]()
- [An Other one]()
- ...
### License
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.