about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md66
1 files changed, 0 insertions, 66 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index 25bba0f..0000000
--- a/README.md
+++ /dev/null
@@ -1,66 +0,0 @@
-<h1 align="center">
-  <br>
-  <img src="https://upload.wikimedia.org/wikipedia/commons/2/28/Nix_snowflake.svg" alt="nix snowflake logo" width="200">
-  <br>
-  nix flake templates — just one `nix flake init`
-  <br>
-  <br>
-</h1>
-
-## 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#<template-name>` 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.