Skip to content

Commit 28bf275

Browse files
author
Sukant Hajra
committed
Update documentation
1 parent 11eb725 commit 28bf275

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ If you want to check that everything builds before flashing your keyboard, you c
242242
tree $(nix build --no-link --print-out-paths) 2>/dev/null
243243
```
244244

245-
/nix/store/hlbrxw8vx245lirw8p8p0s675nay1fm7-shajra-keyboards-checks
245+
/nix/store/56gyv0n22n9wr86vny6xip0zgmbmhrip-shajra-keyboards-checks
246246
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/7a5kd6xizxm5x09mxshf1qfpa1py19zi-ergodoxez-builtin-shajra-flash-env
247247
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/5lszgjc7g6i2fikir6dh2nzdqb2diq3j-ergodoxez-builtin-shajra.hex
248248
├── build-ergodoxez-factory-flash -> /nix/store/d8wshcfxjl8ybl7pm1cwyz831s8f3c3z-ergodoxez-factory-flash-env
@@ -259,10 +259,10 @@ tree $(nix build --no-link --print-out-paths) 2>/dev/null
259259
├── build-moonlander-builtin-shajra-hex -> /nix/store/if1fv7wd55dzpqky58fvjjwkljk4c6xd-moonlander-builtin-shajra.bin
260260
├── build-moonlander-factory-flash -> /nix/store/iyk1qz59d3cxabjkp6dwaiwf0mqaaj9h-moonlander-factory-flash-env
261261
├── build-moonlander-factory-hex -> /nix/store/4wn4zz0cv0hifcpckbcsk1g0hfhdqj46-moonlander-factory.bin
262-
├── flash-ergodoxez -> /nix/store/f6xlfwx1ch836a3h8afv3hicadh811v8-flash-ergodoxez-env
263-
├── flash-model01 -> /nix/store/43x1x3zv91z34fkdacqlh8rcv1nqrwd8-flash-model01-env
264-
├── flash-model100 -> /nix/store/ivq4w018y9as717w03vni77b3lipfyz3-flash-model100-env
265-
├── flash-moonlander -> /nix/store/h487bz3h4m2f83fvfdbhz7c1622v5kr7-flash-moonlander-env
262+
├── flash-ergodoxez -> /nix/store/wvw0zfj58q31ccy2wr53nzzqbxz8nv42-flash-ergodoxez-env
263+
├── flash-model01 -> /nix/store/c9078b0ixasrqji825yb8k8b34by91dl-flash-model01-env
264+
├── flash-model100 -> /nix/store/gxwpcrlaf0widq0w5qf8fxpxhvij54ki-flash-model100-env
265+
├── flash-moonlander -> /nix/store/cyw9l5dlbya686nn7kq8qd0ngpi7nncf-flash-moonlander-env
266266
├── licenses -> /nix/store/13yrsvyhnfjv8m6b62bsahjic6bp3cb4-shajra-keyboards-licenses-env
267267
├── support-arduino-upgrade -> /nix/store/pbgwjq9wnm303j5sxfg8j1vqbbpl3da0-arduino-upgrade-env
268268
└── support-kaleidoscope-deps -> /nix/store/djnk6qp6j0k9dljzji8017msfwpfg7sh-kaleidoscope-deps-env

README.org

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ tree $(nix build --no-link --print-out-paths) 2>/dev/null
310310

311311
#+results: nix-build
312312
#+begin_example
313-
/nix/store/hlbrxw8vx245lirw8p8p0s675nay1fm7-shajra-keyboards-checks
313+
/nix/store/56gyv0n22n9wr86vny6xip0zgmbmhrip-shajra-keyboards-checks
314314
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/7a5kd6xizxm5x09mxshf1qfpa1py19zi-ergodoxez-builtin-shajra-flash-env
315315
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/5lszgjc7g6i2fikir6dh2nzdqb2diq3j-ergodoxez-builtin-shajra.hex
316316
├── build-ergodoxez-factory-flash -> /nix/store/d8wshcfxjl8ybl7pm1cwyz831s8f3c3z-ergodoxez-factory-flash-env
@@ -327,10 +327,10 @@ tree $(nix build --no-link --print-out-paths) 2>/dev/null
327327
├── build-moonlander-builtin-shajra-hex -> /nix/store/if1fv7wd55dzpqky58fvjjwkljk4c6xd-moonlander-builtin-shajra.bin
328328
├── build-moonlander-factory-flash -> /nix/store/iyk1qz59d3cxabjkp6dwaiwf0mqaaj9h-moonlander-factory-flash-env
329329
├── build-moonlander-factory-hex -> /nix/store/4wn4zz0cv0hifcpckbcsk1g0hfhdqj46-moonlander-factory.bin
330-
├── flash-ergodoxez -> /nix/store/f6xlfwx1ch836a3h8afv3hicadh811v8-flash-ergodoxez-env
331-
├── flash-model01 -> /nix/store/43x1x3zv91z34fkdacqlh8rcv1nqrwd8-flash-model01-env
332-
├── flash-model100 -> /nix/store/ivq4w018y9as717w03vni77b3lipfyz3-flash-model100-env
333-
├── flash-moonlander -> /nix/store/h487bz3h4m2f83fvfdbhz7c1622v5kr7-flash-moonlander-env
330+
├── flash-ergodoxez -> /nix/store/wvw0zfj58q31ccy2wr53nzzqbxz8nv42-flash-ergodoxez-env
331+
├── flash-model01 -> /nix/store/c9078b0ixasrqji825yb8k8b34by91dl-flash-model01-env
332+
├── flash-model100 -> /nix/store/gxwpcrlaf0widq0w5qf8fxpxhvij54ki-flash-model100-env
333+
├── flash-moonlander -> /nix/store/cyw9l5dlbya686nn7kq8qd0ngpi7nncf-flash-moonlander-env
334334
├── licenses -> /nix/store/13yrsvyhnfjv8m6b62bsahjic6bp3cb4-shajra-keyboards-licenses-env
335335
├── support-arduino-upgrade -> /nix/store/pbgwjq9wnm303j5sxfg8j1vqbbpl3da0-arduino-upgrade-env
336336
└── support-kaleidoscope-deps -> /nix/store/djnk6qp6j0k9dljzji8017msfwpfg7sh-kaleidoscope-deps-env

doc/nix-installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Hopefully, this alleviates any worry about installing a complex program on your
3939

4040
> **<span class="underline">NOTE:</span>** You don't need this step if you're running NixOS, which comes with Nix baked in.
4141
42-
Though the latest version of Nix is Nix 2.33.3, we'll be installing the version that the last release of NixOS (25.11) uses, specifically Nix 2.31.2. As discussed in the included [introduction to Nix](nix-introduction.md), this version is considered stable by the Nix community.
42+
Though the latest version of Nix is Nix 2.34.0, we'll be installing the version that the last release of NixOS (25.11) uses, specifically Nix 2.31.2. As discussed in the included [introduction to Nix](nix-introduction.md), this version is considered stable by the Nix community.
4343

4444
The following command calls the official installation script for the recommended version of Nix. Note, this script will require `sudo` access.
4545

doc/nix-introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ However, if industrial users move to flakes to address these problems, we have t
194194

195195
### Nix quick releases compete with stability<a id="sec-4-2-3"></a>
196196

197-
The latest major version of the Nix package manager is currently Nix 2.33.3, but NixOS 25.11, the latest stable release of NixOS, uses Nix 2.31.2. NixOS is the primary way the Nix package manager gets used in the field. Far fewer users install Nix as a package manager atop another operating system. From a community perspective it makes sense to consider Nix 2.31.2 the stable release of the package manager. This version gets the most scrutiny and critical bug fixes.
197+
The latest major version of the Nix package manager is currently Nix 2.34.0, but NixOS 25.11, the latest stable release of NixOS, uses Nix 2.31.2. NixOS is the primary way the Nix package manager gets used in the field. Far fewer users install Nix as a package manager atop another operating system. From a community perspective it makes sense to consider Nix 2.31.2 the stable release of the package manager. This version gets the most scrutiny and critical bug fixes.
198198

199199
As mentioned above, there are strong reasons to use still-experimental features, particularly flakes. However, APIs and calculated hashes change too frequently in experimental features from version-to-version. By sticking with the version used in NixOS, we get less breaking changes. For example, the [flake.lock](../flake.lock) file included with this project has calculated hashes for dependencies. These hashes were computed with Nix 2.31.2, and could change with later versions.
200200

0 commit comments

Comments
 (0)