Minor changes

README.md

@@ -1,7 +1,7 @@
 # My firmware for CRKBDv3
 
-A custom firmware written for the [Corne keyboard](https://github.com/foostan/crkbd/) (a DIY ergonomic & ortholinear
-keyboard), and based on [QMK](https://github.com/qmk/qmk_firmware/).
+A custom firmware written for the [Corne keyboard](https://github.com/foostan/crkbd/) (a DIY ergonomic &
+ortholinear keyboard), and based on [QMK](https://github.com/qmk/qmk_firmware/).
 
 
 ## Layout
@@ -10,47 +10,51 @@ keyboard), and based on [QMK](https://github.com/qmk/qmk_firmware/).
 
 **NOTES:**
 
- * *There are 2 "modes" available, `Typing` and `Gaming`; the former comprised of the first 3 layers, while the latter
-    corresponds to the last 2.*
+ * *There are 2 “modes” available, `Typing` and `Gaming`; the former comprised of the first 3 layers, while the
+    latter corresponds to the last 2.*
    * *The Typing mode is intended for general purpose use, though might be a bit inclined towards coding.*
-   * *The Gaming mode focuses heavily in taking advantage of its split nature. This allows it to use the left side
-      independently, leaving more room for mouse movement; while also allowing to use both halves in keyboard focused
-      titles.*
-   * *Even though the keyboard has no indicators to show on which mode its in, you can easily make sure that you are in
-      the desired one by pressing either both the inner most thumb keys or the middle thumb keys (the first for getting
-      into typing mode, the second to get into gaming mode). Keep in mind that the left key should be pressed before the
-      right one (at least to get out of gaming mode).*
- * *Keys labelled L0 - L4 are for switching layers. Keys that change from one "mode" to the other are one way, while the
-    rest are only active when held.*
+   * *The Gaming mode focuses heavily in taking advantage of its split nature. This allows it to use the left
+      side independently, leaving more room for mouse movement; while also allowing to use both halves in
+      keyboard focused titles.*
+   * *Even though the keyboard has no indicators to show on which mode its in, you can easily make sure that you
+      are in the desired one by pressing either both the innermost thumb keys or the middle thumb keys (the first
+      for getting into typing mode, the second to get into gaming mode). Keep in mind that the left key should be
+      pressed before the right one (at least to get out of gaming mode).*
+ * *Keys labelled L0 — L4 are for switching layers. Keys that change from one “mode” to the other are one way,
+    while the rest are only active when held.*
  * *The `GUI` key is also called either Windows, Command, or Super key, depending on the system.*
- * *`Backspace/Delete` key changes behaviour when shift is pressed. Similarly for `Backspace/Esc` and the control key.*
- * *The `Space/L1` and `Enter/L2` work so that if the keys are only tapped then the first value in inputted, but when
-    held then they momentarily activate the assigned layer as long as they remain pressed.*
+ * *`Backspace/Delete` key changes behaviour when shift is pressed. Similarly for `Backspace/Esc` and the control
+    key.*
+ * *The `Space/L1` and `Enter/L2` work so that if the keys are only tapped then the first value in inputted, but
+    when held then they momentarily activate the assigned layer as long as they remain pressed.*
 * *The PC needs to be set up to use en-US keyboard layout, otherwise it will not work as expected.*
 
 
-## How to ...
+## How to …
 
 ### Build the keyboard
 
 First, you'll need to acquire the base components for the build. The board schematics are all openly available @
-[GitHub](https://github.com/foostan/crkbd/), so you can try and get your own PCBs made wherever you want, but I bought
-mine from [Keyhive](https://keyhive.xyz/corne) in a nice kit containing most of the basics. To that I had to add in the
-MCUs, a TRRS cable, 42 key switches and keycaps, and a USB-A to USB-C cable.
+[GitHub](https://github.com/foostan/crkbd/), so you can try and get your own PCBs made wherever you want, but I
+bought mine from [Keyhive](https://keyhive.xyz/corne) in a nice kit containing most of the basics. To that I had
+to add in the MCUs, a TRRS cable, 42 key switches and keycaps, and a USB-A to USB-C cable.
 
-Once you have everything you just have to put it all together. It is intuitive enough but there is also a
-[handy-dandy build guide](https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v3/buildguide_en.md) that you
-can follow if needed.
+Once you have everything you just have to put it all together. It is intuitive enough, but there is also a
+[handy-dandy build guide](https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v3/buildguide_en.md) that
+you can follow if needed.
 
 ### Put the firmware onto the keyboard
 
 This depends on your system, so I'll reference the [official guide](https://docs.qmk.fm/#/newbs) on this one.
 
-You'll notice though that this is not inside the QMK repo itself, as the guide indicates. That's because I wanted to
-keep my own separate repo to keep things simpler (at least, from a certain point of view). To actually be able to use
-this keymap you'll need to copy the entire contents of this repo onto a folder inside of the keyboard's
-[keymaps folder](https://github.com/qmk/qmk_firmware/tree/master/keyboards/crkbd/keymaps/). Then you can follow the
-guide without problem.
+You'll notice though that this is not inside the QMK repo itself, as the guide indicates. That's because I wanted
+to keep my own separate repo to keep things simpler (at least, from a certain point of view). To actually be able
+to use this keymap you'll need to copy the entire contents of this repo onto a folder inside the keyboard's
+[keymaps folder](https://github.com/qmk/qmk_firmware/tree/master/keyboards/crkbd/keymaps/). Then you can follow
+the guide without problem.
+
+I've also included a set of scripts in the shape of a [Nix shell](./shell.nix), which will fetch all dependencies
+automagically. This allows to easily manage the unconventional setup under nearly any Linux system.
 
 
 ## TODOs
@@ -61,10 +65,10 @@ guide without problem.
      [#8789](https://github.com/qmk/qmk_firmware/issues/8789).
 
 
-## Licenses
+## Licences
 
 All the contents of this repo are distributed under the [GPLv3](./LICENSE), except the font
 [Victor Mono](https://rubjo.github.io/victor-mono/) used for the image for the layout of the keyboard, which is
-distributed under the [MIT license](https://github.com/rubjo/victor-mono/blob/master/LICENSE). The board itself is also
-released under the [MIT license](https://github.com/foostan/crkbd/blob/main/LICENSE), and QMK is under
+distributed under the [MIT licence](https://github.com/rubjo/victor-mono/blob/master/LICENSE). The board itself
+is also released under the [MIT licence](https://github.com/foostan/crkbd/blob/main/LICENSE), and QMK is under
 [GPLv2](https://github.com/qmk/qmk_firmware/blob/master/LICENSE).

shell.nix

@@ -421,6 +421,7 @@ Usual development goes something along the lines:
 # Install Nix
 sh <(curl -L 'https://nixos.org/nix/install') --no-daemon
 # Clone keymap repo
+# If you don't clone, an empty repo will be initialised later on
 git clone 'https://github.com/<USER>/<REPO>/' '<WORKDIR>'
 cd '<WORKDIR>'
 # Enter Nix+QMK toolbox
@@ -499,6 +500,10 @@ the sections 1 and 3 failed ( 2^(1-1) + 2^(3-1) = 5 ).
 From the exit code you may be able to inspect the shell.nix file to determine
 the source of the issue (the entirety of the relevant code is in there in a
 monolithic file).
+.PP
+If you want to open an issue or a PR feel free to do so @
+.br
+https://github.com/kip93/qmk-crkbd/
 EOF
 
       return 0
@@ -516,6 +521,7 @@ EOF
       '${pkgs.coreutils}/bin/printf' '\033[0m     , , , , , ,\n'
       '${pkgs.coreutils}/bin/printf' '\n'
       '${pkgs.coreutils}/bin/printf' '\033[0m\033[3mType `help` to get info on available commands.\033[0m\n'
+      '${pkgs.coreutils}/bin/printf' '\n'
 
       return 0
     }