docs: Move README to asciidoc
All checks were successful
ci/woodpecker/push/ci Pipeline was successful

This commit is contained in:
Daniel Lundin 2024-11-23 20:56:34 +01:00
parent 69fd02b21c
commit 2700288e9b
Signed by: dln
SSH key fingerprint: SHA256:dQy1Xj3UiqJYpKR5ggQ2bxgz4jCH8IF+k3AB8o0kmdI
2 changed files with 43 additions and 36 deletions

43
README.adoc Normal file
View file

@ -0,0 +1,43 @@
:showtitle:
:toc: right
:icons: font
== My Rust Project
[link=https://ci.patagia.dev/repos/7,window=_blank]
image::https://ci.patagia.dev/api/badges/7/status.svg[Build Status]
This is an opinionated template for rust projects using Nix.
== Template features
- CI template for Woodpecker.
- Forgejo commit message templates.
- Linting and formatting.
- Nix-centered development environment.
- Include language servers and all tooling in Nix dev shell.
=== Rust Opinions
- https://github.com/oxalica/rust-overlay[rust-overlay] to manage rust version.
- https://nexte.st[nextest] for running tests.
- https://github.com/rui314/mold[mold] for faster linking.
- https://github.com/rust-lang/rustfmt[rustfmt] for code formatting.
- https://github.com/rust-lang/rust-clippy[clippy] for linting.
== Dev tools by default
- https://direnv.net[direnv] for automatic dev shell activation.
- https://dystroy.org/bacon/[Bacon] - automatic and minimal interaction code checker.
- https://github.com/bnjbvr/cargo-machete[cargo-machete] for removing unused dependencies.
- https://github.com/sharkdp/hyperfine[hyperfine] for simple benchmarking.
- https://just.systems/man/en/[just] for running things and discovery.
- https://github.com/watchexec/watchexec[watchexec] (and https://github.com/watchexec/cargo-watch[cargo-watch]) for watching files and running commands.
=== Nix opinions
- https://github.com/ipetkov/crane[Crane] for incremental artifact builds and nice set of checks.
- https://github.com/rustsec/advisory-db[Advisory-db]
for automatic checking of vulnerabilities of dependencies.
- https://github.com/numtide/nix-filter[nix-filter] allows filtering out files from the source input for a project.
- https://github.com/numtide/treefmt-nix[treefmt] supports automatic code formatting of all kinds of source code.

View file

@ -1,36 +0,0 @@
# My Rust Project
This is an opinionated template for rust projects using Nix.
## Template features
- CI template for Woodpecker.
- Forgejo commit message templates.
- Linting and formatting.
- Nix-centered development environment.
- Include language servers and all tooling in Nix dev shell.
### Rust Opinions
- [rust-overlay](https://github.com/oxalica/rust-overlay) to manage rust version.
- [nextest](https://nexte.st) for running tests.
- [mold](https://github.com/rui314/mold) for faster linking.
- [rustfmt](https://github.com/rust-lang/rustfmt) for code formatting.
- [clippy](https://github.com/rust-lang/rust-clippy) for linting.
## Dev tools by default
- [direnv](https://direnv.net) for automatic dev shell activation.
- [Bacon](https://dystroy.org/bacon/) - automatic and minimal interaction code checker.
- [cargo-machete](https://github.com/bnjbvr/cargo-machete) for removing unused dependencies.
- [hyperfine](https://github.com/sharkdp/hyperfine) for simple benchmarking.
- [just](https://just.systems/man/en/) for running things and discovery.
- [watchexec](https://github.com/watchexec/watchexec) (and [cargo-watch](https://github.com/watchexec/cargo-watch)) for watching files and running commands.
### Nix opinions
- [Crane](https://github.com/ipetkov/crane) for incremental artifact builds and nice set of checks.
- [Advisory-db](https://github.com/rustsec/advisory-db)
for automatic checking of vulnerabilities of dependencies.
- [nix-filter](https://github.com/numtide/nix-filter) allows filtering out files from the source input for a project.
- [treefmt](https://github.com/numtide/treefmt-nix) supports automatic code formatting of all kinds of source code.