repository template for Rust projects
docs: cleanup README.md again (#36)
authored by
GitHub
8c315773
e2a876d5
+9
-12
+9
-12
README.md
+9
-12
README.md
···
29
29
- `my-crate`, `my_crate` - Replace this with the name of your crate.
30
30
31
31
## Configure
32
-
| Tool | File path | Reference |
33
-
|--------------------------|----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
34
-
| GitHub Codespaces | [`devcontainer.json`](./.devcontainer/devcontainer.json) | [Reference](https://containers.dev/implementors/json_reference/) |
35
-
| GitHub Actions | [`.github/workflows`](./.github/workflows) | [Reference](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) |
36
-
| Cargo package | [`Cargo.toml`](crates/pkg1/Cargo.toml) | [Reference](https://doc.rust-lang.org/cargo/reference/manifest.html) |
37
-
| Clippy (Rust linter) | [`.clippy.toml`](./.clippy.toml) | [Repository](https://github.com/rust-lang/rust-clippy), [Reference]( https://rust-lang.github.io/rust-clippy/) |
38
-
| Rustfmt (Rust formatter) | [`.rustfmt.toml`](./.rustfmt.toml) | [Repository](https://github.com/rust-lang/rustfmt), [Reference](https://rust-lang.github.io/rustfmt/) |
32
+
| Tool | File path | Reference |
33
+
|---------------------|--------------------------------------------|----------------------------------------------------------------------------------------------------------------|
34
+
| GitHub Actions CI | [`.github/workflows`](./.github/workflows) | [Reference](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) |
35
+
| Cargo package | [`Cargo.toml`](./Cargo.toml) | [Reference](https://doc.rust-lang.org/cargo/reference/manifest.html) |
36
+
| Clippy (Linter) | [`.clippy.toml`](./.clippy.toml) | [Repository](https://github.com/rust-lang/rust-clippy), [Reference]( https://rust-lang.github.io/rust-clippy/) |
37
+
| Rustfmt (Formatter) | [`.rustfmt.toml`](./.rustfmt.toml) | [Repository](https://github.com/rust-lang/rustfmt), [Reference](https://rust-lang.github.io/rustfmt/) |
39
38
40
39
## Run scripts locally
41
40
| Script | Command |
42
41
|-------------|---------|
43
-
| Run unit/integration/doc tests | `cargo test` |
42
+
| Run tests | `cargo test` |
44
43
| Run Rustfmt | `cargo fmt` |
45
44
| Run Clippy | `cargo clippy` |
46
-
| Generate API docs for crate | `cargo doc` |
47
-
| Run security audits | `cargo audit`[^cargo-audit] |
48
-
49
-
[^cargo-audit]: Requires installing [`cargo-audit`](https://crates.io/crates/cargo-audit) locally
45
+
| Build crate documentation | `cargo doc` |
46
+
| Run security audits | `cargo audit` (with [`cargo-audit`](https://crates.io/crates/cargo-audit)) |