From 023fa7cf9ed2211d0618283af4a067fad8e5737f Mon Sep 17 00:00:00 2001 From: voidarc Date: Thu, 20 Aug 2026 14:38:02 +0100 Subject: [PATCH] made the readme better --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a058b6b..d99208f 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,22 @@ _An opinionated dendritic nix configuration_ ![Picture of Neovim open, editing the hyprland repo](assets/desktop-2-v2.png) +## Get Started + +No cloning required + +```bash +# Run any app (replace appname with the one you want) +nix run "git+https://git.voidarc.co.uk/voidarc/nixos.git#appname" + +# Build configuration (HACKSTATION or mobile02) +sudo nixos-rebuild switch --impure --flake "git+https://git.voidarc.co.uk/voidarc/nixos.git#mobile02" +``` + +[More Information on Configs](#nixos-configurations) + +[More Information on Binaries](#binaries) + ## The Concept I have been trying to get consistent, across device experiences from the second that I @@ -102,6 +118,9 @@ environment variable is not available, the zsh module will throw and evaluation but the build will not be hindered. ```bash +# The following commands will only work if your hostname is already +# HACKSTATION or mobile02, if it is not, see next code block + # Local Clone, . is the directory containing flake.nix sudo nixos-rebuild switch --impure --flake . @@ -124,7 +143,7 @@ default password is `qwer`. No, that isn't my usual password. ### Binaries -Any binary can be run with the same base command (will change when merged to main) +Any binary can be run with the same base command: ```bash nix run "git+https://git.voidarc.co.uk/voidarc/nixos.git#appname" @@ -134,7 +153,7 @@ nix run "git+https://git.voidarc.co.uk/voidarc/nixos.git#appname" `kitty` or `otter-launcher`. Most if not all modules in a subdirectory will have a module name corresponding to that directory. This only applies for `default.nix` files, so files that have different names are not expected to follow this convention, even if there is not -ea `default.nix` in that directory. +a `default.nix` in that directory. ## Issues and contributing