diff --git a/.gitignore b/.gitignore index 09e9e2d..564c965 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,3 @@ result* .direnv/ - -flake.lock -!/flake.lock diff --git a/README.md b/README.md new file mode 100644 index 0000000..4fba2d5 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# Toki's Nix Flake Template Repository + +This is my personal collection of Nix flake templates for various programming +languages and build systems. + +## Motivation + +There already exists an [official repository of flake +templates](https://github.com/NixOS/templates), so why make my own? + +I have a few different reasons: + +- **Comprehensiveness:** The official template repository is rather small and + doesn't have most of the templates I would actually want to use. +- **Consistency:** The templates in the official repository are contributed by + community members, and there's very little stylistic or structural consistency + between them. +- **Preference:** The structure of a flake can be very opinionated, and most of + the official flake templates are rather poorly constructed by my standards, + often not bothering to follow established best practices. + +## Usage + +Flake templates are used with the `nix flake init` command: + +```sh +nix flake init -t git+https://git.tokinanpa.dev/toki/templates#