https://github.com/sshine/hello-rs
A Cargo generate workspace template
https://github.com/sshine/hello-rs
Last synced: about 1 year ago
JSON representation
A Cargo generate workspace template
- Host: GitHub
- URL: https://github.com/sshine/hello-rs
- Owner: sshine
- Created: 2023-05-04T00:21:52.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-23T06:06:19.000Z (about 3 years ago)
- Last Synced: 2025-02-05T08:13:37.553Z (over 1 year ago)
- Language: Rust
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# {{project-name}}
[](https://github.com/{{github-username}}/{{project-name}}/actions)
{{description}}
## Getting started
To contribute, install the Rust toolchain, e.g. using [rustup][rustup]:
```sh
curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh
```
[rustup]: https://rustup.rs/
You can run the test suite like so:
```sh
cargo test --all-targets
```
{% if false %}
## This is a `cargo generate` template
*(This section won't occur when using this template.)*
`cargo generate` is a powerful alternative to the built-in `cargo new`:
### Usage
To install `cargo generate`, run:
```sh
cargo install cargo-generate
```
Create new template, either from GitHub, or from a local path:
```sh
cargo generate --git https://github.com/sshine/workspace-template
cargo generate --path $HOME/Projects/workspace-template
```
### Config
Create a `cargo gen` shortcut by adding a section to ~/.cargo/config.toml:
```toml
[alias]
gen = "generate"
```
Add your `github-username` to ~/.cargo/cargo-generate.toml:
```toml
[values]
github-username = "sshine"
```
### Learn
Read more about `cargo generate` here:
- https://github.com/cargo-generate/cargo-generate
- https://cargo-generate.github.io/cargo-generate/index.html
{% endif %}