Skip to content

Commit

Permalink
Update dependencies and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Sukant Hajra committed Aug 11, 2024
1 parent eef09fc commit 7a97758
Show file tree
Hide file tree
Showing 8 changed files with 96 additions and 96 deletions.
48 changes: 24 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,8 @@ nix run github:shajra/shajra-keyboards#flash-ergodoxez
Flashing ZSA Technology Lab's Ergodox EZ (custom "shajra" keymap)
=================================================================

FLASH SOURCE: /nix/store/042g9rxp5svl0r8licdvgcpz9pdik1gm-qmk-builtin-shajra-src
FLASH BINARY: /nix/store/37qvazv1vr35839gh57rsf94i058kbmn-ergodoxez-builtin-shajra.hex
FLASH SOURCE: /nix/store/ksf3y3pilp826las0ppa16aaaigij9yk-qmk-builtin-shajra-src
FLASH BINARY: /nix/store/qbghy10w797f080f0s8r4dj7w386f37f-ergodoxez-builtin-shajra.hex

⠋ Press the reset button of your keyboard

Expand Down Expand Up @@ -242,28 +242,28 @@ If you want to check that everything builds before flashing your keyboard, you c
tree $(nix build --no-link --print-out-paths) 2>/dev/null
```

/nix/store/cqh02vwq6s2xqkp01alqyb8z00fj0in6-shajra-keyboards-ci
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/sawk61ii56qfw9j6nmb4wf2gd2yzqa0a-ergodoxez-builtin-shajra-flash
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/37qvazv1vr35839gh57rsf94i058kbmn-ergodoxez-builtin-shajra.hex
├── build-ergodoxez-factory-flash -> /nix/store/8wcj0186fgk0yi23x5rhjq9rkl35s13g-ergodoxez-factory-flash
├── build-ergodoxez-factory-hex -> /nix/store/pnwcmm64g26cc8cbx63caqfi35dlkjhs-ergodoxez-factory.hex
├── build-model01-builtin-shajra-flash -> /nix/store/w58wg6plq82xcvqy1wqcr83mk1bjdsyl-model01-builtin-shajra-flash
├── build-model01-builtin-shajra-hex -> /nix/store/hka3r64krc0f2l4vnc43r25ci8p2z9fr-model01-builtin-shajra-hex
├── build-model01-factory-flash -> /nix/store/qz8i5x0kc1bamzj69jyxriy1qzivdiwm-model01-factory-flash
├── build-model01-factory-hex -> /nix/store/vafvhj4kr64y7ry6afd07saxj0nm0siy-model01-factory-hex
├── build-model100-builtin-shajra-flash -> /nix/store/nsbkz1l8pgjjchw5qvh6h9af015l0q6b-model100-builtin-shajra-flash
├── build-model100-builtin-shajra-hex -> /nix/store/pnzarsgkwhsi27ms3plhfdda0fpch5fi-model100-builtin-shajra-hex
├── build-model100-factory-flash -> /nix/store/87f14hrp45jfb6b3q9mnj2q5nkfc3dmp-model100-factory-flash
├── build-model100-factory-hex -> /nix/store/gfdkfm9cm8ihq5js6ly399i7gc27ikm8-model100-factory-hex
├── build-moonlander-builtin-shajra-flash -> /nix/store/l5xk7nys9vgcc0nfi5zj20gjz3xbvigv-moonlander-builtin-shajra-flash
├── build-moonlander-builtin-shajra-hex -> /nix/store/p0z57wzqdhk0jmnprlx3lcnwhsxhsmyx-moonlander-builtin-shajra.bin
├── build-moonlander-factory-flash -> /nix/store/wk913rfcm072f2r5fvjda9gnc67pdn0g-moonlander-factory-flash
├── build-moonlander-factory-hex -> /nix/store/wfaq1z23x03g0mg6i8yy5111sf37l6qh-moonlander-factory.bin
├── flash-ergodoxez -> /nix/store/y9ynsp16hpdppq23firr7dlwwnf9y868-flash-ergodoxez
├── flash-model01 -> /nix/store/c6m6d5qsybdqzq80r2shi0n9irgmkgim-flash-model01
├── flash-model100 -> /nix/store/abrz5hp7nm9ffgk9wy2wrv002r25vp7b-flash-model100
├── flash-moonlander -> /nix/store/awyi905896pkdb2g6941s7pw21rpwzj0-flash-moonlander
└── licenses -> /nix/store/rril0rr02bvmm4dza3wcvwa3r9z2z6wf-shajra-keyboards-licenses
/nix/store/z532sfzf11zxbbbj8dhl178ngy6ch16l-shajra-keyboards-ci
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/7i1bnmnf4fyv52jmjg27yp18gj0rnsj5-ergodoxez-builtin-shajra-flash
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/qbghy10w797f080f0s8r4dj7w386f37f-ergodoxez-builtin-shajra.hex
├── build-ergodoxez-factory-flash -> /nix/store/frnbiic4fsnx49p8cq7s2pa7dajb9857-ergodoxez-factory-flash
├── build-ergodoxez-factory-hex -> /nix/store/0qa7vrbmih0mg07lq9ra6cy38b1y9dbh-ergodoxez-factory.hex
├── build-model01-builtin-shajra-flash -> /nix/store/56rcgplf25gyvzwwhh3x75999n09fc6d-model01-builtin-shajra-flash
├── build-model01-builtin-shajra-hex -> /nix/store/r79l0knm2gnkmbk2if56ggx05kzns9vy-model01-builtin-shajra-hex
├── build-model01-factory-flash -> /nix/store/0y30s2hk7xc0nvfi8fdwr5w62wppz1r4-model01-factory-flash
├── build-model01-factory-hex -> /nix/store/pp8qhajm9m4xpkpi33qsgclzbclvi043-model01-factory-hex
├── build-model100-builtin-shajra-flash -> /nix/store/56xr3n6q15mnhziv58pxk9xf3prrg8jg-model100-builtin-shajra-flash
├── build-model100-builtin-shajra-hex -> /nix/store/vj381g20z8nqgww5435lcf8mwlkc61vw-model100-builtin-shajra-hex
├── build-model100-factory-flash -> /nix/store/gvpbagz74mlwsx06wghw7viwmjcrp8z0-model100-factory-flash
├── build-model100-factory-hex -> /nix/store/cvx0c6n5rsmydkdnazj9xn504psayh5b-model100-factory-hex
├── build-moonlander-builtin-shajra-flash -> /nix/store/90whvvhicgi0mfqagfr59cp8ayj1404a-moonlander-builtin-shajra-flash
├── build-moonlander-builtin-shajra-hex -> /nix/store/kdjs06vznajd5jdwznsaid4nbr8sc5dq-moonlander-builtin-shajra.bin
├── build-moonlander-factory-flash -> /nix/store/gmnhiav2qpxs1v982gkispalzqvz8l51-moonlander-factory-flash
├── build-moonlander-factory-hex -> /nix/store/c07hlz8lc2f714z7lgp6wyikycfw940i-moonlander-factory.bin
├── flash-ergodoxez -> /nix/store/yhnibk61ws0llbrladrnvd2p70hsmv2c-flash-ergodoxez
├── flash-model01 -> /nix/store/bzcp4jfxr4ff17p0zqvi4r2001lpv0c4-flash-model01
├── flash-model100 -> /nix/store/rz14j2p51p10y9ad1r8nnyypzcjclpqc-flash-model100
├── flash-moonlander -> /nix/store/yblnj0r40fjnm19rrdrkq0yzsyr18x2n-flash-moonlander
└── licenses -> /nix/store/pib2ncbhdr6g815bsw10kf1j9xd2kj9q-shajra-keyboards-licenses

18 directories, 4 files

Expand Down
48 changes: 24 additions & 24 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,8 @@ head -c350 < <(./flash-ergodoxez) | ansifilter
: Flashing ZSA Technology Lab's Ergodox EZ (custom "shajra" keymap)
: =================================================================
:
: FLASH SOURCE: /nix/store/042g9rxp5svl0r8licdvgcpz9pdik1gm-qmk-builtin-shajra-src
: FLASH BINARY: /nix/store/37qvazv1vr35839gh57rsf94i058kbmn-ergodoxez-builtin-shajra.hex
: FLASH SOURCE: /nix/store/ksf3y3pilp826las0ppa16aaaigij9yk-qmk-builtin-shajra-src
: FLASH BINARY: /nix/store/qbghy10w797f080f0s8r4dj7w386f37f-ergodoxez-builtin-shajra.hex
:
: ⠋ Press the reset button of your keyboard

Expand Down Expand Up @@ -308,28 +308,28 @@ tree $(nix build --no-link --print-out-paths) 2>/dev/null

#+results: nix-build
#+begin_example
/nix/store/cqh02vwq6s2xqkp01alqyb8z00fj0in6-shajra-keyboards-ci
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/sawk61ii56qfw9j6nmb4wf2gd2yzqa0a-ergodoxez-builtin-shajra-flash
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/37qvazv1vr35839gh57rsf94i058kbmn-ergodoxez-builtin-shajra.hex
├── build-ergodoxez-factory-flash -> /nix/store/8wcj0186fgk0yi23x5rhjq9rkl35s13g-ergodoxez-factory-flash
├── build-ergodoxez-factory-hex -> /nix/store/pnwcmm64g26cc8cbx63caqfi35dlkjhs-ergodoxez-factory.hex
├── build-model01-builtin-shajra-flash -> /nix/store/w58wg6plq82xcvqy1wqcr83mk1bjdsyl-model01-builtin-shajra-flash
├── build-model01-builtin-shajra-hex -> /nix/store/hka3r64krc0f2l4vnc43r25ci8p2z9fr-model01-builtin-shajra-hex
├── build-model01-factory-flash -> /nix/store/qz8i5x0kc1bamzj69jyxriy1qzivdiwm-model01-factory-flash
├── build-model01-factory-hex -> /nix/store/vafvhj4kr64y7ry6afd07saxj0nm0siy-model01-factory-hex
├── build-model100-builtin-shajra-flash -> /nix/store/nsbkz1l8pgjjchw5qvh6h9af015l0q6b-model100-builtin-shajra-flash
├── build-model100-builtin-shajra-hex -> /nix/store/pnzarsgkwhsi27ms3plhfdda0fpch5fi-model100-builtin-shajra-hex
├── build-model100-factory-flash -> /nix/store/87f14hrp45jfb6b3q9mnj2q5nkfc3dmp-model100-factory-flash
├── build-model100-factory-hex -> /nix/store/gfdkfm9cm8ihq5js6ly399i7gc27ikm8-model100-factory-hex
├── build-moonlander-builtin-shajra-flash -> /nix/store/l5xk7nys9vgcc0nfi5zj20gjz3xbvigv-moonlander-builtin-shajra-flash
├── build-moonlander-builtin-shajra-hex -> /nix/store/p0z57wzqdhk0jmnprlx3lcnwhsxhsmyx-moonlander-builtin-shajra.bin
├── build-moonlander-factory-flash -> /nix/store/wk913rfcm072f2r5fvjda9gnc67pdn0g-moonlander-factory-flash
├── build-moonlander-factory-hex -> /nix/store/wfaq1z23x03g0mg6i8yy5111sf37l6qh-moonlander-factory.bin
├── flash-ergodoxez -> /nix/store/y9ynsp16hpdppq23firr7dlwwnf9y868-flash-ergodoxez
├── flash-model01 -> /nix/store/c6m6d5qsybdqzq80r2shi0n9irgmkgim-flash-model01
├── flash-model100 -> /nix/store/abrz5hp7nm9ffgk9wy2wrv002r25vp7b-flash-model100
├── flash-moonlander -> /nix/store/awyi905896pkdb2g6941s7pw21rpwzj0-flash-moonlander
└── licenses -> /nix/store/rril0rr02bvmm4dza3wcvwa3r9z2z6wf-shajra-keyboards-licenses
/nix/store/z532sfzf11zxbbbj8dhl178ngy6ch16l-shajra-keyboards-ci
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/7i1bnmnf4fyv52jmjg27yp18gj0rnsj5-ergodoxez-builtin-shajra-flash
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/qbghy10w797f080f0s8r4dj7w386f37f-ergodoxez-builtin-shajra.hex
├── build-ergodoxez-factory-flash -> /nix/store/frnbiic4fsnx49p8cq7s2pa7dajb9857-ergodoxez-factory-flash
├── build-ergodoxez-factory-hex -> /nix/store/0qa7vrbmih0mg07lq9ra6cy38b1y9dbh-ergodoxez-factory.hex
├── build-model01-builtin-shajra-flash -> /nix/store/56rcgplf25gyvzwwhh3x75999n09fc6d-model01-builtin-shajra-flash
├── build-model01-builtin-shajra-hex -> /nix/store/r79l0knm2gnkmbk2if56ggx05kzns9vy-model01-builtin-shajra-hex
├── build-model01-factory-flash -> /nix/store/0y30s2hk7xc0nvfi8fdwr5w62wppz1r4-model01-factory-flash
├── build-model01-factory-hex -> /nix/store/pp8qhajm9m4xpkpi33qsgclzbclvi043-model01-factory-hex
├── build-model100-builtin-shajra-flash -> /nix/store/56xr3n6q15mnhziv58pxk9xf3prrg8jg-model100-builtin-shajra-flash
├── build-model100-builtin-shajra-hex -> /nix/store/vj381g20z8nqgww5435lcf8mwlkc61vw-model100-builtin-shajra-hex
├── build-model100-factory-flash -> /nix/store/gvpbagz74mlwsx06wghw7viwmjcrp8z0-model100-factory-flash
├── build-model100-factory-hex -> /nix/store/cvx0c6n5rsmydkdnazj9xn504psayh5b-model100-factory-hex
├── build-moonlander-builtin-shajra-flash -> /nix/store/90whvvhicgi0mfqagfr59cp8ayj1404a-moonlander-builtin-shajra-flash
├── build-moonlander-builtin-shajra-hex -> /nix/store/kdjs06vznajd5jdwznsaid4nbr8sc5dq-moonlander-builtin-shajra.bin
├── build-moonlander-factory-flash -> /nix/store/gmnhiav2qpxs1v982gkispalzqvz8l51-moonlander-factory-flash
├── build-moonlander-factory-hex -> /nix/store/c07hlz8lc2f714z7lgp6wyikycfw940i-moonlander-factory.bin
├── flash-ergodoxez -> /nix/store/yhnibk61ws0llbrladrnvd2p70hsmv2c-flash-ergodoxez
├── flash-model01 -> /nix/store/bzcp4jfxr4ff17p0zqvi4r2001lpv0c4-flash-model01
├── flash-model100 -> /nix/store/rz14j2p51p10y9ad1r8nnyypzcjclpqc-flash-model100
├── flash-moonlander -> /nix/store/yblnj0r40fjnm19rrdrkq0yzsyr18x2n-flash-moonlander
└── licenses -> /nix/store/pib2ncbhdr6g815bsw10kf1j9xd2kj9q-shajra-keyboards-licenses

18 directories, 4 files
#+end_example
Expand Down
2 changes: 1 addition & 1 deletion doc/internal/params.el
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
;; run-type must be "executable"
(run-target-short . "shajra-keyboards-licenses")
;; run-target-long will always prefix "bin/"
(nix-latest . "2.23.3")
(nix-latest . "2.24.1")
(nix-stable . "2.18.5")
(nixos-latest . "24.05")
(platforms . "Linux on x86-64 machines"))
2 changes: 1 addition & 1 deletion doc/nix-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Hopefully, this alleviates any worry about installing a complex program on your

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

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

Expand Down
2 changes: 1 addition & 1 deletion doc/nix-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ However, if industrial users move to flakes to address these problems, we have t

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

The latest major version of the Nix package manager is currently Nix 2.23.3, but NixOS 24.05, the latest stable release of NixOS, uses Nix 2.18.5. 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.18.5 the stable release of the package manager. This version gets the most scrutiny and critical bug fixes.
The latest major version of the Nix package manager is currently Nix 2.24.1, but NixOS 24.05, the latest stable release of NixOS, uses Nix 2.18.5. 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.18.5 the stable release of the package manager. This version gets the most scrutiny and critical bug fixes.

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.18.5, and could change with later versions.

Expand Down
8 changes: 4 additions & 4 deletions doc/nix-usage-flakes.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ After a successful call of `nix build`, you'll see one or more symlinks for each
readlink result*
```

/nix/store/rril0rr02bvmm4dza3wcvwa3r9z2z6wf-shajra-keyboards-licenses
/nix/store/pib2ncbhdr6g815bsw10kf1j9xd2kj9q-shajra-keyboards-licenses

Following these symlinks, we can see the files the project provides:

Expand All @@ -287,7 +287,7 @@ It's common to configure these “result” symlinks as ignored in source contro
nix path-info .#licenses-thirdparty
```

/nix/store/rril0rr02bvmm4dza3wcvwa3r9z2z6wf-shajra-keyboards-licenses
/nix/store/pib2ncbhdr6g815bsw10kf1j9xd2kj9q-shajra-keyboards-licenses

## Running commands in a shell<a id="sec-4-6"></a>

Expand Down Expand Up @@ -400,7 +400,7 @@ nix shell --ignore-environment \
--command which shajra-keyboards-licenses
```

/nix/store/rril0rr02bvmm4dza3wcvwa3r9z2z6wf-shajra-keyboards-licenses/bin/shajra-keyboards-licenses
/nix/store/pib2ncbhdr6g815bsw10kf1j9xd2kj9q-shajra-keyboards-licenses/bin/shajra-keyboards-licenses

What we do with local flake references can work just as well with remote flake references.

Expand Down Expand Up @@ -428,7 +428,7 @@ nix profile list
Flake attribute: packages.x86_64-linux.licenses-thirdparty
Original flake URL: git+file:///home/shajra/src/shajra-keyboards
Locked flake URL: git+file:///home/shajra/src/shajra-keyboards
Store paths: /nix/store/rril0rr02bvmm4dza3wcvwa3r9z2z6wf-shajra-keyboards-licenses
Store paths: /nix/store/pib2ncbhdr6g815bsw10kf1j9xd2kj9q-shajra-keyboards-licenses

If we want to uninstall a program from our profile, we do so by the index from this list:

Expand Down
8 changes: 4 additions & 4 deletions doc/nix-usage-flakes.org
Original file line number Diff line number Diff line change
Expand Up @@ -445,7 +445,7 @@ readlink result*
#+end_src

#+RESULTS: nix-build-link
: /nix/store/rril0rr02bvmm4dza3wcvwa3r9z2z6wf-shajra-keyboards-licenses
: /nix/store/pib2ncbhdr6g815bsw10kf1j9xd2kj9q-shajra-keyboards-licenses

Following these symlinks, we can see the files the project provides:

Expand Down Expand Up @@ -474,7 +474,7 @@ nix path-info .#<<get("package-attr-short")>>
#+end_src

#+results: nix-build-path
: /nix/store/rril0rr02bvmm4dza3wcvwa3r9z2z6wf-shajra-keyboards-licenses
: /nix/store/pib2ncbhdr6g815bsw10kf1j9xd2kj9q-shajra-keyboards-licenses

** Running commands in a shell

Expand Down Expand Up @@ -636,7 +636,7 @@ nix shell --ignore-environment \
#+end_src

#+RESULTS: nix-shell-remote
: /nix/store/rril0rr02bvmm4dza3wcvwa3r9z2z6wf-shajra-keyboards-licenses/bin/shajra-keyboards-licenses
: /nix/store/pib2ncbhdr6g815bsw10kf1j9xd2kj9q-shajra-keyboards-licenses/bin/shajra-keyboards-licenses

What we do with local flake references can work just as well with remote flake
references.
Expand Down Expand Up @@ -687,7 +687,7 @@ nix profile list --profile /tmp/nix-profile | ansifilter
: Flake attribute: packages.x86_64-linux.licenses-thirdparty
: Original flake URL: git+file:///home/shajra/src/shajra-keyboards
: Locked flake URL: git+file:///home/shajra/src/shajra-keyboards
: Store paths: /nix/store/rril0rr02bvmm4dza3wcvwa3r9z2z6wf-shajra-keyboards-licenses
: Store paths: /nix/store/pib2ncbhdr6g815bsw10kf1j9xd2kj9q-shajra-keyboards-licenses

If we want to uninstall a program from our profile, we do so by the index from
this list:
Expand Down
Loading

0 comments on commit 7a97758

Please sign in to comment.