From 89c7c337d25d2645f70fd67aae55c47672f7873e Mon Sep 17 00:00:00 2001 From: jhonas Date: Thu, 3 Mar 2022 11:49:00 +0100 Subject: [PATCH] Improve Readme --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index e862119..7cfa1bc 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ [![asciicast](https://asciinema.org/a/pIGfe11qb3r33WstkkFW7BSuF.svg)](https://asciinema.org/a/pIGfe11qb3r33WstkkFW7BSuF) -0. If you're already on NixOS and / or have worked with `flakes` before, jump to **2.** -1. [Install nix, the package manager](https://nixos.org/download.html) +0. If you're already on NixOS and / or have worked with `flakes` before, **jump** to **2.** +1. [**Install** nix, the package manager](https://nixos.org/download.html) 1. Now, make sure you're ready to `nix` with flakes, this should give you some output: @@ -15,28 +15,30 @@ `nix`): https://nixos.wiki/wiki/Flakes#Installing_flakes -2. Get this nix flake template, it will be setup in a new directory +2. **Get** this nix flake template, it will be setup in a new directory `./tritonshell` (feel free to adjust this): ``` -nix flake new --template "git+https://git.greenbaum.cloud/dev/tritonshell?ref=main" ./tritonshell -cd tritonshell +nix flake new --template "git+https://git.greenbaum.cloud/dev/tritonshell?ref=main" ./tritonshell \ +&& cd tritonshell ``` -3. Adjust `./flake.nix` to match domains and data centers of your Triton Data -Center setup. Look for the `CUSTOMIZE` comment. Greenbaum Cloud users skip +3. **Optional**: **Adjust** `./flake.nix` to match domains and data centers of your Triton Data +Center setup. Look for the `CUSTOMIZE` comment. + +Greenbaum Cloud users skip this step, everything's preconfigured. ``` vim ./flake.nix ``` -4. Ready to go: +4. **Ready** to go: ``` nix develop ``` **Optional**: -If you'd like to customize your new tritonshell with additional packages, you +If you'd like to add **additional packages** to your new tritonshell, you can do so: just edit `flake.nix` and look for `extraDevshellPkgs`. Packages added here will be pulled from the `nixos-unstable` channel, you can [search for available packages here](https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=hello).