From ae0f2d3d2f9167f7257d4d4337d6d2187d343072 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= Date: Thu, 21 Sep 2023 14:40:38 +0200 Subject: [PATCH] docs/quickstart: use the clan create command and mention flake.nix more --- docs/quickstart.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 5efea0766..afe99555f 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -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