From 2abc618fa26da15be0e3a4843858e5a65a4ff6d6 Mon Sep 17 00:00:00 2001 From: Benedikt Peetz Date: Tue, 11 Jun 2024 10:07:35 +0200 Subject: fix(README): Remove the `.md` suffix --- README | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 66 --------------------------------------------------------------- 2 files changed, 66 insertions(+), 66 deletions(-) create mode 100644 README delete mode 100644 README.md diff --git a/README b/README new file mode 100644 index 0000000..25bba0f --- /dev/null +++ b/README @@ -0,0 +1,66 @@ +

+
+ nix snowflake logo +
+ nix flake templates — just one `nix flake init` +
+
+

+ +## Quick start + +Add this flake to your flake registry, for example on NixOS like this: + +```nix +# services/nix/default.nix +nix.registry = { + t.flake = nix_flake_templates; +}; +``` + +Then you can just create a new directory and run `nix flake init -t t#` and +run the `init` script, like so: + +```bash +mkdir lfcd +cd lfcd + +# initialize the template +nix flake init -t t#rust + +# set the executable bit on the `init` script and run it to populate the meta-data. +chmod +x ./init && ./init +``` + +## Supported templates + +These are the actively supported templates (i.e. they are updated, whence I update my +process.). The key features of these templates have been highlighted. + +### awk + +### c + +- Makefile with build directory support + +### latex + +- `lpm` and a file heavy structure included, to ensure visibility of the document structure at an FS level +- `build.sh` script to automate the building process + +### rust + +- `Cargo.toml` and `cog.toml` already pre-populated with the values from the `init` script + to allow a release on `crates.io`. + +### shell + +- Hooked up to [my shell library](https://shell-lib.b-peetz.de). + +## License + +Unless explicitly stated otherwise, any contribution intentionally +submitted for inclusion will be licensed under the [GPL-3.0-or-later +License](./COPYING). Beware that this license only affects the code in +this repository, not the generated templates nor the general inclusion +in your flake. diff --git a/README.md b/README.md deleted file mode 100644 index 25bba0f..0000000 --- a/README.md +++ /dev/null @@ -1,66 +0,0 @@ -

-
- nix snowflake logo -
- nix flake templates — just one `nix flake init` -
-
-

- -## Quick start - -Add this flake to your flake registry, for example on NixOS like this: - -```nix -# services/nix/default.nix -nix.registry = { - t.flake = nix_flake_templates; -}; -``` - -Then you can just create a new directory and run `nix flake init -t t#` and -run the `init` script, like so: - -```bash -mkdir lfcd -cd lfcd - -# initialize the template -nix flake init -t t#rust - -# set the executable bit on the `init` script and run it to populate the meta-data. -chmod +x ./init && ./init -``` - -## Supported templates - -These are the actively supported templates (i.e. they are updated, whence I update my -process.). The key features of these templates have been highlighted. - -### awk - -### c - -- Makefile with build directory support - -### latex - -- `lpm` and a file heavy structure included, to ensure visibility of the document structure at an FS level -- `build.sh` script to automate the building process - -### rust - -- `Cargo.toml` and `cog.toml` already pre-populated with the values from the `init` script - to allow a release on `crates.io`. - -### shell - -- Hooked up to [my shell library](https://shell-lib.b-peetz.de). - -## License - -Unless explicitly stated otherwise, any contribution intentionally -submitted for inclusion will be licensed under the [GPL-3.0-or-later -License](./COPYING). Beware that this license only affects the code in -this repository, not the generated templates nor the general inclusion -in your flake. -- cgit 1.4.1