From d1b810dfadf41e7cd6780beb743fb90b09305750 Mon Sep 17 00:00:00 2001 From: a-kenji Date: Tue, 7 May 2024 15:45:38 +0200 Subject: [PATCH] docs: improve getting started prerequisite docs --- docs/site/index.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/site/index.md b/docs/site/index.md index b964cbcd..2b5516f6 100644 --- a/docs/site/index.md +++ b/docs/site/index.md @@ -17,28 +17,28 @@ Create your own clan with these initial steps. ### Prerequisites -#### Linux +=== "**Linux**" -Clan depends on nix installed on your system. Run the following command to install nix. + Clan depends on nix installed on your system. Run the following command to install nix. -```bash -curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install -``` + ```bash + curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install + ``` -#### NixOS +=== "**NixOS**" -If you run NixOS the `nix` binary is already installed. + If you run NixOS the `nix` binary is already installed. -You will also need to enable the `flakes` and `nix-commands` experimental features. + You will also need to enable the `flakes` and `nix-commands` experimental features. -```bash -# /etc/nix/nix.conf or ~/.config/nix/nix.conf -experimental-features = nix-command flakes -``` + ```bash + # /etc/nix/nix.conf or ~/.config/nix/nix.conf + experimental-features = nix-command flakes + ``` -#### Other +=== "**Other**" -Clan doesn't offer dedicated support for other operating systems yet. + Clan doesn't offer dedicated support for other operating systems yet. ### Step 1: Add Clan CLI to Your Shell @@ -57,6 +57,7 @@ clan flakes create my-clan ``` This command creates the `flake.nix` and `.clan-flake` files for your project. +It will also generate files from a default template, to help show general clan usage patterns. ### Step 3: Verify the Project Structure