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 Jun 23, 2024
1 parent 3852bf3 commit 0caa21a
Show file tree
Hide file tree
Showing 10 changed files with 97 additions and 97 deletions.
48 changes: 24 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,8 @@ nix run github:shajra/shajra-keyboards#flash-ergodoxez
Flashing ZSA Technology Lab's Ergodox EZ (custom "shajra" keymap)
=================================================================

FLASH SOURCE: /nix/store/4zqmrp505vbgn2j7cqzj62hn83nlzfx4-qmk-builtin-shajra-src
FLASH BINARY: /nix/store/6nadvrw03w5jqjcv32bdkdvbgnw8qx6m-ergodoxez-builtin-shajra.hex
FLASH SOURCE: /nix/store/yy539wjj04l36ndwsi0jndz6crp5bjy0-qmk-builtin-shajra-src
FLASH BINARY: /nix/store/7ncnbjsz1bpq9kpdm0imbcfsawrv7l9l-ergodoxez-builtin-shajra.hex

⠋ Press the reset button of your keyboard

Expand Down Expand Up @@ -240,28 +240,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/l8p3njjgnvya5dki699f64aa9q27sfyr-shajra-keyboards-ci
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/ngkm3rc40n17dmajg465g3x7ma6i51q7-ergodoxez-builtin-shajra-flash
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/6nadvrw03w5jqjcv32bdkdvbgnw8qx6m-ergodoxez-builtin-shajra.hex
├── build-ergodoxez-factory-flash -> /nix/store/7k2sr6czw6ga5bbfbysdp66k4wwmfh3w-ergodoxez-factory-flash
├── build-ergodoxez-factory-hex -> /nix/store/0d5wpclgi928kv1n1q546l8zl0c8iwb3-ergodoxez-factory.hex
├── build-model01-builtin-shajra-flash -> /nix/store/zf1396mgjgaasr9yqps2pyalq7wibqj1-model01-builtin-shajra-flash
├── build-model01-builtin-shajra-hex -> /nix/store/w49cqmsx30pyja0758hd8kbw71009j1m-model01-builtin-shajra-hex
├── build-model01-factory-flash -> /nix/store/2ng6490627k22zrf9d2kp1m01byyab0k-model01-factory-flash
├── build-model01-factory-hex -> /nix/store/8iix5f2y1sixnk2nys5jlncv5hnynwmx-model01-factory-hex
├── build-model100-builtin-shajra-flash -> /nix/store/5c1qmdwfibaj805zyqmigfx91my7yii1-model100-builtin-shajra-flash
├── build-model100-builtin-shajra-hex -> /nix/store/1dhxzq6mz4yjli2vwfm56z360a7ih531-model100-builtin-shajra-hex
├── build-model100-factory-flash -> /nix/store/3mdsnqwjavwg54yyxj2ml8fkagf3rlsz-model100-factory-flash
├── build-model100-factory-hex -> /nix/store/jsjg8fla0f5sn8rkfha473108gb5ykra-model100-factory-hex
├── build-moonlander-builtin-shajra-flash -> /nix/store/yibybxj81nzcgriljqs2q2h8gvf7nv1d-moonlander-builtin-shajra-flash
├── build-moonlander-builtin-shajra-hex -> /nix/store/k90kpczvf7ig326bz85v6rsf43qws8g9-moonlander-builtin-shajra.bin
├── build-moonlander-factory-flash -> /nix/store/iy1safxkwvlcyrnrs5cfki91xd70yrbl-moonlander-factory-flash
├── build-moonlander-factory-hex -> /nix/store/4slix4rilrxhdsnic5xnxvpd57zv328w-moonlander-factory.bin
├── flash-ergodoxez -> /nix/store/6yk1ybblj46l70lyyjzg8f84sq63iwx0-flash-ergodoxez
├── flash-model01 -> /nix/store/cy883mga86p46jadd56s03j429rw2bbn-flash-model01
├── flash-model100 -> /nix/store/ms10rh6axyfjp3b6mrw7d50fcvrhqbsf-flash-model100
├── flash-moonlander -> /nix/store/02lc2c9kvlfdykh98pdp1n4x4f0lb3xc-flash-moonlander
└── licenses -> /nix/store/wiicaqjqy3wwpf7w2mpj1fhsd9s1i1zx-shajra-keyboards-licenses
/nix/store/hpp7xh114mcbq52hwp79gdiddnlqp571-shajra-keyboards-ci
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/ifqgfjnwl1kylcv32w0zlx12fq8c7vp7-ergodoxez-builtin-shajra-flash
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/7ncnbjsz1bpq9kpdm0imbcfsawrv7l9l-ergodoxez-builtin-shajra.hex
├── build-ergodoxez-factory-flash -> /nix/store/ad8hy4ak3bkcilg397rrc0gxcpmrx7gk-ergodoxez-factory-flash
├── build-ergodoxez-factory-hex -> /nix/store/i9lrl4w1xi1nzydc7a195i9zgkrp8ddc-ergodoxez-factory.hex
├── build-model01-builtin-shajra-flash -> /nix/store/vzhbbclgb921h0762hb9r2yjfim3virn-model01-builtin-shajra-flash
├── build-model01-builtin-shajra-hex -> /nix/store/pldkl177jmkb7qm05s11ynjdhyi2n8wl-model01-builtin-shajra-hex
├── build-model01-factory-flash -> /nix/store/x3931w0iqj55583y40q43j3rqhbd2r9k-model01-factory-flash
├── build-model01-factory-hex -> /nix/store/v4xmaz2ik12piyiwvlisi866biyyyxsw-model01-factory-hex
├── build-model100-builtin-shajra-flash -> /nix/store/5ybi2xi3kg2yd625kwybc4k79rbrnr7z-model100-builtin-shajra-flash
├── build-model100-builtin-shajra-hex -> /nix/store/yvm9hpks835xmf1xl654v13w8na7axa8-model100-builtin-shajra-hex
├── build-model100-factory-flash -> /nix/store/5j5sj4i6c2by1qm8aalrhm6shzqnnldi-model100-factory-flash
├── build-model100-factory-hex -> /nix/store/i6vq0qiszwvlzcr05kg8frqxzdgskf9q-model100-factory-hex
├── build-moonlander-builtin-shajra-flash -> /nix/store/c2x781cb9yz06hai6i75rkj8lsq8440y-moonlander-builtin-shajra-flash
├── build-moonlander-builtin-shajra-hex -> /nix/store/f1kw1wa6lmb3sfjwhmj9w6dpag5ikdb3-moonlander-builtin-shajra.bin
├── build-moonlander-factory-flash -> /nix/store/najipnfhp8bfi72sgcy7lbbgpy2p2830-moonlander-factory-flash
├── build-moonlander-factory-hex -> /nix/store/qaq133zqkzydfryrbmnznaz1p1ry2652-moonlander-factory.bin
├── flash-ergodoxez -> /nix/store/z31ba1rqrlnckzv9s1cfg6iayk43d16w-flash-ergodoxez
├── flash-model01 -> /nix/store/1562g9i9k53l8vfizj7rc2xj6lqbi3gd-flash-model01
├── flash-model100 -> /nix/store/9734qn6pja315g52892j2jsy885mjkwd-flash-model100
├── flash-moonlander -> /nix/store/vd6xham5s55jkxazr2qml96i7ikc5663-flash-moonlander
└── licenses -> /nix/store/43ax4fl6g7si85jx1v3z6j1jixjsjd7f-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 @@ -209,8 +209,8 @@ head -c350 < <(./flash-ergodoxez) | ansifilter
: Flashing ZSA Technology Lab's Ergodox EZ (custom "shajra" keymap)
: =================================================================
:
: FLASH SOURCE: /nix/store/4zqmrp505vbgn2j7cqzj62hn83nlzfx4-qmk-builtin-shajra-src
: FLASH BINARY: /nix/store/6nadvrw03w5jqjcv32bdkdvbgnw8qx6m-ergodoxez-builtin-shajra.hex
: FLASH SOURCE: /nix/store/yy539wjj04l36ndwsi0jndz6crp5bjy0-qmk-builtin-shajra-src
: FLASH BINARY: /nix/store/7ncnbjsz1bpq9kpdm0imbcfsawrv7l9l-ergodoxez-builtin-shajra.hex
:
: ⠋ Press the reset button of your keyboard

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

#+results: nix-build
#+begin_example
/nix/store/l8p3njjgnvya5dki699f64aa9q27sfyr-shajra-keyboards-ci
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/ngkm3rc40n17dmajg465g3x7ma6i51q7-ergodoxez-builtin-shajra-flash
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/6nadvrw03w5jqjcv32bdkdvbgnw8qx6m-ergodoxez-builtin-shajra.hex
├── build-ergodoxez-factory-flash -> /nix/store/7k2sr6czw6ga5bbfbysdp66k4wwmfh3w-ergodoxez-factory-flash
├── build-ergodoxez-factory-hex -> /nix/store/0d5wpclgi928kv1n1q546l8zl0c8iwb3-ergodoxez-factory.hex
├── build-model01-builtin-shajra-flash -> /nix/store/zf1396mgjgaasr9yqps2pyalq7wibqj1-model01-builtin-shajra-flash
├── build-model01-builtin-shajra-hex -> /nix/store/w49cqmsx30pyja0758hd8kbw71009j1m-model01-builtin-shajra-hex
├── build-model01-factory-flash -> /nix/store/2ng6490627k22zrf9d2kp1m01byyab0k-model01-factory-flash
├── build-model01-factory-hex -> /nix/store/8iix5f2y1sixnk2nys5jlncv5hnynwmx-model01-factory-hex
├── build-model100-builtin-shajra-flash -> /nix/store/5c1qmdwfibaj805zyqmigfx91my7yii1-model100-builtin-shajra-flash
├── build-model100-builtin-shajra-hex -> /nix/store/1dhxzq6mz4yjli2vwfm56z360a7ih531-model100-builtin-shajra-hex
├── build-model100-factory-flash -> /nix/store/3mdsnqwjavwg54yyxj2ml8fkagf3rlsz-model100-factory-flash
├── build-model100-factory-hex -> /nix/store/jsjg8fla0f5sn8rkfha473108gb5ykra-model100-factory-hex
├── build-moonlander-builtin-shajra-flash -> /nix/store/yibybxj81nzcgriljqs2q2h8gvf7nv1d-moonlander-builtin-shajra-flash
├── build-moonlander-builtin-shajra-hex -> /nix/store/k90kpczvf7ig326bz85v6rsf43qws8g9-moonlander-builtin-shajra.bin
├── build-moonlander-factory-flash -> /nix/store/iy1safxkwvlcyrnrs5cfki91xd70yrbl-moonlander-factory-flash
├── build-moonlander-factory-hex -> /nix/store/4slix4rilrxhdsnic5xnxvpd57zv328w-moonlander-factory.bin
├── flash-ergodoxez -> /nix/store/6yk1ybblj46l70lyyjzg8f84sq63iwx0-flash-ergodoxez
├── flash-model01 -> /nix/store/cy883mga86p46jadd56s03j429rw2bbn-flash-model01
├── flash-model100 -> /nix/store/ms10rh6axyfjp3b6mrw7d50fcvrhqbsf-flash-model100
├── flash-moonlander -> /nix/store/02lc2c9kvlfdykh98pdp1n4x4f0lb3xc-flash-moonlander
└── licenses -> /nix/store/wiicaqjqy3wwpf7w2mpj1fhsd9s1i1zx-shajra-keyboards-licenses
/nix/store/hpp7xh114mcbq52hwp79gdiddnlqp571-shajra-keyboards-ci
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/ifqgfjnwl1kylcv32w0zlx12fq8c7vp7-ergodoxez-builtin-shajra-flash
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/7ncnbjsz1bpq9kpdm0imbcfsawrv7l9l-ergodoxez-builtin-shajra.hex
├── build-ergodoxez-factory-flash -> /nix/store/ad8hy4ak3bkcilg397rrc0gxcpmrx7gk-ergodoxez-factory-flash
├── build-ergodoxez-factory-hex -> /nix/store/i9lrl4w1xi1nzydc7a195i9zgkrp8ddc-ergodoxez-factory.hex
├── build-model01-builtin-shajra-flash -> /nix/store/vzhbbclgb921h0762hb9r2yjfim3virn-model01-builtin-shajra-flash
├── build-model01-builtin-shajra-hex -> /nix/store/pldkl177jmkb7qm05s11ynjdhyi2n8wl-model01-builtin-shajra-hex
├── build-model01-factory-flash -> /nix/store/x3931w0iqj55583y40q43j3rqhbd2r9k-model01-factory-flash
├── build-model01-factory-hex -> /nix/store/v4xmaz2ik12piyiwvlisi866biyyyxsw-model01-factory-hex
├── build-model100-builtin-shajra-flash -> /nix/store/5ybi2xi3kg2yd625kwybc4k79rbrnr7z-model100-builtin-shajra-flash
├── build-model100-builtin-shajra-hex -> /nix/store/yvm9hpks835xmf1xl654v13w8na7axa8-model100-builtin-shajra-hex
├── build-model100-factory-flash -> /nix/store/5j5sj4i6c2by1qm8aalrhm6shzqnnldi-model100-factory-flash
├── build-model100-factory-hex -> /nix/store/i6vq0qiszwvlzcr05kg8frqxzdgskf9q-model100-factory-hex
├── build-moonlander-builtin-shajra-flash -> /nix/store/c2x781cb9yz06hai6i75rkj8lsq8440y-moonlander-builtin-shajra-flash
├── build-moonlander-builtin-shajra-hex -> /nix/store/f1kw1wa6lmb3sfjwhmj9w6dpag5ikdb3-moonlander-builtin-shajra.bin
├── build-moonlander-factory-flash -> /nix/store/najipnfhp8bfi72sgcy7lbbgpy2p2830-moonlander-factory-flash
├── build-moonlander-factory-hex -> /nix/store/qaq133zqkzydfryrbmnznaz1p1ry2652-moonlander-factory.bin
├── flash-ergodoxez -> /nix/store/z31ba1rqrlnckzv9s1cfg6iayk43d16w-flash-ergodoxez
├── flash-model01 -> /nix/store/1562g9i9k53l8vfizj7rc2xj6lqbi3gd-flash-model01
├── flash-model100 -> /nix/store/9734qn6pja315g52892j2jsy885mjkwd-flash-model100
├── flash-moonlander -> /nix/store/vd6xham5s55jkxazr2qml96i7ikc5663-flash-moonlander
└── licenses -> /nix/store/43ax4fl6g7si85jx1v3z6j1jixjsjd7f-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,6 +10,6 @@
;; run-type must be "executable"
(run-target-short . "shajra-keyboards-licenses")
;; run-target-long will always prefix "bin/"
(nix-latest . "2.22")
(nix-latest . "2.23")
(nixos-latest . "24.05")
(platforms . "Linux on x86-64 machines"))
4 changes: 2 additions & 2 deletions doc/nix-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,13 +93,13 @@ To use flakes there are two things we need to do:
1. make sure the version of Nix we're on is at least 2.4
2. enable both the `nix-command` and `flakes` experimental features.

Since the latest release of Nix is already at 2.22, if you installed Nix recently as per the instructions above, you should be on a recent-enough version:
Since the latest release of Nix is already at 2.23, if you installed Nix recently as per the instructions above, you should be on a recent-enough version:

```sh
nix --version
```

nix (Nix) 2.18.1
nix (Nix) 2.18.2

The easiest way to turn on experimental features is to create a file `~/.config/nix/nix.conf` if it doesn't already exist, and in it, put the following line:

Expand Down
2 changes: 1 addition & 1 deletion doc/nix-installation.org
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ nix --version
#+end_src

#+RESULTS: nix-version
: nix (Nix) 2.18.1
: nix (Nix) 2.18.2

The easiest way to turn on experimental features is to create a file
=~/.config/nix/nix.conf= if it doesn't already exist, and in it, put the
Expand Down
14 changes: 7 additions & 7 deletions doc/nix-language.md
Original file line number Diff line number Diff line change
Expand Up @@ -413,13 +413,13 @@ nix eval --impure --expr '
```

{
lastModified = 1705312282;
lastModifiedDate = "20240115095122";
narHash = "sha256-PPXqKY2hJng4DBVE0I4xshv/vGLUskL7jl53roB8UdU=";
outPath = "/nix/store/wjb45dlgycjw8759q43js031yjn5l0g5-source";
rev = "7c2f768bf9601268a4e71c2ebe91e2011918a70f";
revCount = 843;
shortRev = "7c2f768";
lastModified = 1718457448;
lastModifiedDate = "20240615131728";
narHash = "sha256-FSoxTcRZMGHNJh8dNtKOkcUtjhmhU6yQXcZZfUPLhQM=";
outPath = "/nix/store/z1lyf7s6klqvd97027b56lmckm5p9hik-source";
rev = "a0f54334df36770b335c051e540ba40afcbf8378";
revCount = 844;
shortRev = "a0f5433";
submodules = false;
}

Expand Down
14 changes: 7 additions & 7 deletions doc/nix-language.org
Original file line number Diff line number Diff line change
Expand Up @@ -541,13 +541,13 @@ nix eval --impure --expr '
#+RESULTS:
#+begin_example
{
lastModified = 1705312282;
lastModifiedDate = "20240115095122";
narHash = "sha256-PPXqKY2hJng4DBVE0I4xshv/vGLUskL7jl53roB8UdU=";
outPath = "/nix/store/wjb45dlgycjw8759q43js031yjn5l0g5-source";
rev = "7c2f768bf9601268a4e71c2ebe91e2011918a70f";
revCount = 843;
shortRev = "7c2f768";
lastModified = 1718457448;
lastModifiedDate = "20240615131728";
narHash = "sha256-FSoxTcRZMGHNJh8dNtKOkcUtjhmhU6yQXcZZfUPLhQM=";
outPath = "/nix/store/z1lyf7s6klqvd97027b56lmckm5p9hik-source";
rev = "a0f54334df36770b335c051e540ba40afcbf8378";
revCount = 844;
shortRev = "a0f5433";
submodules = false;
}
#+end_example
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 @@ -262,7 +262,7 @@ After a successful call of `nix build`, you'll see one or more symlinks for each
readlink result*
```

/nix/store/wiicaqjqy3wwpf7w2mpj1fhsd9s1i1zx-shajra-keyboards-licenses
/nix/store/43ax4fl6g7si85jx1v3z6j1jixjsjd7f-shajra-keyboards-licenses

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

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

/nix/store/wiicaqjqy3wwpf7w2mpj1fhsd9s1i1zx-shajra-keyboards-licenses
/nix/store/43ax4fl6g7si85jx1v3z6j1jixjsjd7f-shajra-keyboards-licenses

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

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

/nix/store/wiicaqjqy3wwpf7w2mpj1fhsd9s1i1zx-shajra-keyboards-licenses/bin/shajra-keyboards-licenses
/nix/store/43ax4fl6g7si85jx1v3z6j1jixjsjd7f-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 @@ -425,7 +425,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/wiicaqjqy3wwpf7w2mpj1fhsd9s1i1zx-shajra-keyboards-licenses
Store paths: /nix/store/43ax4fl6g7si85jx1v3z6j1jixjsjd7f-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 @@ -442,7 +442,7 @@ readlink result*
#+end_src

#+RESULTS: nix-build-link
: /nix/store/wiicaqjqy3wwpf7w2mpj1fhsd9s1i1zx-shajra-keyboards-licenses
: /nix/store/43ax4fl6g7si85jx1v3z6j1jixjsjd7f-shajra-keyboards-licenses

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

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

#+results: nix-build-path
: /nix/store/wiicaqjqy3wwpf7w2mpj1fhsd9s1i1zx-shajra-keyboards-licenses
: /nix/store/43ax4fl6g7si85jx1v3z6j1jixjsjd7f-shajra-keyboards-licenses

** Running commands in a shell

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

#+RESULTS: nix-shell-remote
: /nix/store/wiicaqjqy3wwpf7w2mpj1fhsd9s1i1zx-shajra-keyboards-licenses/bin/shajra-keyboards-licenses
: /nix/store/43ax4fl6g7si85jx1v3z6j1jixjsjd7f-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 @@ -684,7 +684,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/wiicaqjqy3wwpf7w2mpj1fhsd9s1i1zx-shajra-keyboards-licenses
: Store paths: /nix/store/43ax4fl6g7si85jx1v3z6j1jixjsjd7f-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 0caa21a

Please sign in to comment.