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

Merge pull request 'documentation: improve templates section' (#1208) from a-kenji-docs/update-template into main

Browse Source
This commit is contained in:
clan-bot
2024-04-14 09:58:50 +00:00
parent d717d9e90d 3d0d124b8a
commit d1457c424a
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.