From 789e93d61c38ee4aa73750ccaaacbcf46d030bcd Mon Sep 17 00:00:00 2001 From: lassulus Date: Mon, 5 Jun 2023 10:23:08 +0200 Subject: [PATCH] docs: minor fixups --- README.md | 4 +++- docs/HowTo.md | 4 ++-- docs/quickstart.md | 2 +- docs/requirements.md | 4 ++-- docs/supportmatrix.md | 4 ++-- 5 files changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 798eb96..7747617 100644 --- a/README.md +++ b/README.md @@ -82,9 +82,11 @@ A simple disko configuration may look like this: } ``` -If you'd saved this configuration in /tmp/disko-config.nix , and wanted to create a disk named /dev/nvme0n1, you would run the following command to partition, format and mount the disk. +If you'd saved this configuration in /tmp/disko-config.nix, and wanted to create a disk named /dev/nvme0n1, you would run the following command to partition, format and mount the disk. +``` $ sudo nix run github:nix-community/disko -- --mode zap_create_mount /tmp/disko-config.nix --arg disks '[ "/dev/nvme0n1" ]' +``` ## Related Tools diff --git a/docs/HowTo.md b/docs/HowTo.md index 785e2ed..aa755a5 100644 --- a/docs/HowTo.md +++ b/docs/HowTo.md @@ -40,7 +40,7 @@ If you use nix flakes support:
niv - + First add it to [niv](https://github.com/nmattia/niv): ```console @@ -91,7 +91,7 @@ $ nix-channel --update imports = let # replace this with an actual commit id or tag commit = "f2783a8ef91624b375a3cf665c3af4ac60b7c278"; - in [ + in [ "${builtins.fetchTarball { url = "https://github.com/nix-community/disko/archive/${commit}.tar.gz"; # replace this with an actual hash diff --git a/docs/quickstart.md b/docs/quickstart.md index ac83a1a..40e7ae4 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -1,6 +1,6 @@ # disko - Declarative disk partitioning -Project logo +Project logo [Documentation Index](./INDEX.md) diff --git a/docs/requirements.md b/docs/requirements.md index 9fffd93..93d8398 100644 --- a/docs/requirements.md +++ b/docs/requirements.md @@ -2,8 +2,8 @@ -[Documentation Index](./INDEX.md) +[Documentation Index](./INDEX.md) ## System Requirements -TODO: Populate this +TODO: Populate this diff --git a/docs/supportmatrix.md b/docs/supportmatrix.md index a3825d4..53ee715 100644 --- a/docs/supportmatrix.md +++ b/docs/supportmatrix.md @@ -2,8 +2,8 @@ -[Documentation Index](./INDEX.md) +[Documentation Index](./INDEX.md) ## Support Matrix -TODO: Populate this +TODO: Populate this