docs: clean up directory structure

This commit is contained in:
Johannes Kirschbauer
2024-04-13 14:42:37 +02:00
parent 7d543da8c2
commit babf7e3d12
23 changed files with 10 additions and 12 deletions

View File

@@ -0,0 +1,17 @@
# Templates
We provide some starting templates you can easily use one of those via `nix flakes`.
They showcase best practices and guide you through setting up and using Clan's modules
I.e. To use the `new-clan` template run the following command:
`nix flake init -t git+https://git.clan.lol/clan/clan-core#new-clan`.
## Available Templates
We offer the following templates:
To initialize a clan with one of those run `nix flake init -t git+https://git.clan.lol/clan/clan-core#TEMPLATE_NAME`
- **new-clan**: Perfect for beginners, this template shows you how to link two machines in a basic setup.