yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

documentation: improve templates section

Browse Source
This commit is contained in:
a-kenji
2024-04-14 11:51:43 +02:00
parent 9da8b27701
commit cdc9a96c21
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/site/templates/index.md
View File

@@ -6,12 +6,19 @@ They showcase best practices and guide you through setting up and using Clan's m
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`.
```bash
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`
To initialize a clan with one of those run:
```bash
nix flake init -t git+https://git.clan.lol/clan/clan-core#[TEMPLATE_NAME]
```
Substitute `[TEMPLATE_NAME]` with the name of the template.
- **new-clan**: Perfect for beginners, this template shows you how to link two machines in a basic setup.