repository template for Rust projects

docs: cleanup README.md (#45)

authored by samanthanguyen.me and committed by

GitHub 8843d3a8 3a27fd46

+11 -11
+11 -11
README.md
··· 15 15 Choose a method: 16 16 - **GitHub UI**: Press the "Use this template" button in the top-right corner of this page. 17 17 - **GitHub CLI**: Install [GitHub CLI](https://cli.github.com). Then run one of the following: 18 - ```shell 19 - gh repo create --template neoncitylights/php --public --clone {{repository}} # clone as public 20 - gh repo create --template neoncitylights/php --private --clone {{repository}} # clone as private 18 + ```sh 19 + gh repo create --template neoncitylights/rust --public --clone {{repository}} # clone as public 20 + gh repo create --template neoncitylights/rust --private --clone {{repository}} # clone as private 21 21 ``` 22 22 23 23 ### Replace placeholders ··· 30 30 - `my_crate` - Replace this with the name of your crate. 31 31 32 32 ## Configure 33 - | Tool | File path | Reference | 34 - |---------------------|--------------------------------------------|----------------------------------------------------------------------------------------------------------------| 35 - | GitHub Actions CI | [`.github/workflows`](./.github/workflows) | [Reference](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) | 36 - | Cargo package | [`Cargo.toml`](./Cargo.toml) | [Reference](https://doc.rust-lang.org/cargo/reference/manifest.html) | 37 - | Clippy (Linter) | [`.clippy.toml`](./.clippy.toml) | [Repository](https://github.com/rust-lang/rust-clippy), [Reference]( https://rust-lang.github.io/rust-clippy/) | 38 - | Rustfmt (Formatter) | [`.rustfmt.toml`](./.rustfmt.toml) | [Repository](https://github.com/rust-lang/rustfmt), [Reference](https://rust-lang.github.io/rustfmt/) | 33 + | Tool | File path | Reference | 34 + | ---- | --------- | --------- | 35 + | GitHub Actions CI | [`.github/workflows`](./.github/workflows) | [Reference](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) | 36 + | Cargo package | [`Cargo.toml`](./Cargo.toml) | [Reference](https://doc.rust-lang.org/cargo/reference/manifest.html) | 37 + | Clippy (Linter) | [`.clippy.toml`](./.clippy.toml) | [Repository](https://github.com/rust-lang/rust-clippy), [Reference]( https://rust-lang.github.io/rust-clippy/) | 38 + | Rustfmt (Formatter) | [`.rustfmt.toml`](./.rustfmt.toml) | [Repository](https://github.com/rust-lang/rustfmt), [Reference](https://rust-lang.github.io/rustfmt/) | 39 39 40 40 ## Run scripts locally 41 - | Script | Command | 42 - |-------------|---------| 41 + | Script | Command | 42 + | ------ | ------- | 43 43 | Run tests | `cargo test` | 44 44 | Run Rustfmt | `cargo fmt` | 45 45 | Run Clippy | `cargo clippy` |