clan/clan-core
11
2
Fork 13
Code Issues 91 Pull Requests 5 Actions Packages Projects 1 Releases Wiki Activity

Merge pull request 'docs/quickstart: use the clan create command and mention flake.nix more' (#316) from docs into main
All checks were successful
checks-impure / test (push) Successful in 10s
Details
checks / test (push) Successful in 35s
Details
assets1 / test (push) Successful in 6s
Details

Browse Source 
Reviewed-on: #316
This commit is contained in:
Mic92 2023-09-21 12:41:40 +00:00
commit 70374b62c2
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/quickstart.md
View File

@ -2,10 +2,16 @@
## Clone the Clan Template
To start a new project, execute the following command to clone the Clan Core template:
1. To start a new project, execute the following command to add the clan cli to your shell:
```bash
$ nix flake init -t git+https://git.clan.lol/clan/clan-core
$ nix shell git+https://git.clan.lol/clan/clan-core
```
2. Than use the following command to clone the clan core template into the current directory:
```
$ clan create .
```
This action will generate two primary files: `flake.nix` and `.clan-flake`.
@ -24,6 +30,10 @@ drwxrwxrwt root root 139 B 12 seconds ago ../
The `.clan-flake` marker file serves an optional purpose: it helps the `clan-cli` utility locate the project's root directory.
If `.clan-flake` is missing, `clan-cli` will instead search for other indicators like `.git`, `.hg`, `.svn`, or `flake.nix` to identify the project root.
## Modifying the configuration
After cloning the template the next step is to modify the `flake.nix` and follow the instructions in it to add more machines.
---
# Migrating Existing NixOS Configuration Flake