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 Dec 21, 2023
1 parent 1c85354 commit 4184e90
Show file tree
Hide file tree
Showing 7 changed files with 2,031 additions and 346 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/30yrf298k6y7hs17d819xmr8b6anhij7-qmk-builtin-shajra-src
FLASH BINARY: /nix/store/bzv89kgfr2yqsbdngm42277qp420d6vz-ergodoxez-builtin-shajra.hex
FLASH SOURCE: /nix/store/hqdkf9d4b1rqkxpn9qvwwb0arnpsr6qb-qmk-builtin-shajra-src
FLASH BINARY: /nix/store/fs9vidzncsqw4yqfk0xk9glpbpkvkmxj-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/fxnldk4pljj6y8a899hpfazasdf51256-shajra-keyboards-ci
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/fmdkmccwwmil3llbjrikhpr853fag3ap-ergodoxez-builtin-shajra-flash
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/bzv89kgfr2yqsbdngm42277qp420d6vz-ergodoxez-builtin-shajra.hex
├── build-ergodoxez-factory-flash -> /nix/store/2nphw8ncjd34wb77zq1maip3xlkmj848-ergodoxez-factory-flash
├── build-ergodoxez-factory-hex -> /nix/store/v8y8nbsc8f964bab7q4ars30avh80mvj-ergodoxez-factory.hex
├── build-model01-builtin-shajra-flash -> /nix/store/mka6177pwirfbnw41r5fvpxn53ladq97-model01-builtin-shajra-flash
├── build-model01-builtin-shajra-hex -> /nix/store/wgy2rg9cr9zr1r5vshsbw462bdm96ps8-model01-builtin-shajra-hex
├── build-model01-factory-flash -> /nix/store/n2b3c6i1llq968lapajg2614508rmp0s-model01-factory-flash
├── build-model01-factory-hex -> /nix/store/w1zphfpkb09jrijxdppw1f38fvp4ypk1-model01-factory-hex
├── build-model100-builtin-shajra-flash -> /nix/store/p5zaz7mk83lsn9yyyy3rwq4wjyjghbmh-model100-builtin-shajra-flash
├── build-model100-builtin-shajra-hex -> /nix/store/admxy34rly5hnvswzlfn1gchc76hjqzp-model100-builtin-shajra-hex
├── build-model100-factory-flash -> /nix/store/g3pdl1yiy4qmza55kbccdsqfcpdsc35s-model100-factory-flash
├── build-model100-factory-hex -> /nix/store/q7aw2sb6nxq4sfbvm254kmpyjyczai4d-model100-factory-hex
├── build-moonlander-builtin-shajra-flash -> /nix/store/0nlv0y2204ksg68ir39h0sg7z3kmyhcc-moonlander-builtin-shajra-flash
├── build-moonlander-builtin-shajra-hex -> /nix/store/js2yvr01sz5zs2k84f6mh3nn208pna0k-moonlander-builtin-shajra.bin
├── build-moonlander-factory-flash -> /nix/store/d92zdnx8l2mpx33klrvjnmdjs3lwylfi-moonlander-factory-flash
├── build-moonlander-factory-hex -> /nix/store/1206ymbcancln1nqxd7ihv8hpn0ndf81-moonlander-factory.bin
├── flash-ergodoxez -> /nix/store/7fafz6grzpykq8cr24mbfiy80vhas4cp-flash-ergodoxez
├── flash-model01 -> /nix/store/idgdh21zkabv1l4wvskk95jscimczflz-flash-model01
├── flash-model100 -> /nix/store/fx2yhwgk3ipnjk9w2hvx15w6z4m1p7n4-flash-model100
├── flash-moonlander -> /nix/store/52qwin8wwh8c43d1snwvpd21i6jk0hkr-flash-moonlander
└── licenses -> /nix/store/6nryh742rmj5xpn8ikgwdlq5xsn9nkr0-shajra-keyboards-licenses
/nix/store/j519fbc01biiyyls5vml7j5gl3shz15h-shajra-keyboards-ci
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/bpjx6w5518zpffrxlyg15kyb16wj09wn-ergodoxez-builtin-shajra-flash
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/fs9vidzncsqw4yqfk0xk9glpbpkvkmxj-ergodoxez-builtin-shajra.hex
├── build-ergodoxez-factory-flash -> /nix/store/rn37y0mhlyc4xmg733w9vhk3szmkhwka-ergodoxez-factory-flash
├── build-ergodoxez-factory-hex -> /nix/store/prh122s46z8ygdkwbq04jmanhcc7mas3-ergodoxez-factory.hex
├── build-model01-builtin-shajra-flash -> /nix/store/92gg30iwx8sd85p04i77hiqdgg5yvkij-model01-builtin-shajra-flash
├── build-model01-builtin-shajra-hex -> /nix/store/nijc9bqfprkyvb279qczqc9v9nmmm0ni-model01-builtin-shajra-hex
├── build-model01-factory-flash -> /nix/store/5n2r6pcb0d8z8qnmgbyhfs8kb2k5rcsm-model01-factory-flash
├── build-model01-factory-hex -> /nix/store/kkfrx4mfmiyc7r2klb61yxkg83w6lfi2-model01-factory-hex
├── build-model100-builtin-shajra-flash -> /nix/store/6n45v1fpbm1bnr6higj5afc905qzrp3q-model100-builtin-shajra-flash
├── build-model100-builtin-shajra-hex -> /nix/store/53zgxwavx7hzbh5y3y24np1cgc026kiw-model100-builtin-shajra-hex
├── build-model100-factory-flash -> /nix/store/wf853l76qjjqmhal5i1cbraz39v1jgjp-model100-factory-flash
├── build-model100-factory-hex -> /nix/store/wiw7j9c1fixvkk1q8ndfsdh070yhqdk4-model100-factory-hex
├── build-moonlander-builtin-shajra-flash -> /nix/store/ck7r2iy0zcmx2vd47wif5yjb4a74pqki-moonlander-builtin-shajra-flash
├── build-moonlander-builtin-shajra-hex -> /nix/store/s1jy7b079lhrca05hv5kbbrs2m2p412x-moonlander-builtin-shajra.bin
├── build-moonlander-factory-flash -> /nix/store/pxv1fsjk9mmav61f8k2k6drbbl4kk5bs-moonlander-factory-flash
├── build-moonlander-factory-hex -> /nix/store/fcqjr5i2pyfi17cw4x64lxyagh0wfz68-moonlander-factory.bin
├── flash-ergodoxez -> /nix/store/cm31va3absqlhf7qwmn2z1z31fiia27m-flash-ergodoxez
├── flash-model01 -> /nix/store/6wd25bgqvlf2ivgr3vnj52lhmmnnr4il-flash-model01
├── flash-model100 -> /nix/store/hrz4rw4fmyivllm7gkajs0h2g81gnj0c-flash-model100
├── flash-moonlander -> /nix/store/q1d8q4avyxpyic3pqzh3myi00xgckcpn-flash-moonlander
└── licenses -> /nix/store/v1vr721kj917f0skg3sy1jzp6gjh2nkv-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/30yrf298k6y7hs17d819xmr8b6anhij7-qmk-builtin-shajra-src
: FLASH BINARY: /nix/store/bzv89kgfr2yqsbdngm42277qp420d6vz-ergodoxez-builtin-shajra.hex
: FLASH SOURCE: /nix/store/hqdkf9d4b1rqkxpn9qvwwb0arnpsr6qb-qmk-builtin-shajra-src
: FLASH BINARY: /nix/store/fs9vidzncsqw4yqfk0xk9glpbpkvkmxj-ergodoxez-builtin-shajra.hex
:
: ⠋ Press the reset button of your keyboard

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

#+results: nix-build
#+begin_example
/nix/store/fxnldk4pljj6y8a899hpfazasdf51256-shajra-keyboards-ci
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/fmdkmccwwmil3llbjrikhpr853fag3ap-ergodoxez-builtin-shajra-flash
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/bzv89kgfr2yqsbdngm42277qp420d6vz-ergodoxez-builtin-shajra.hex
├── build-ergodoxez-factory-flash -> /nix/store/2nphw8ncjd34wb77zq1maip3xlkmj848-ergodoxez-factory-flash
├── build-ergodoxez-factory-hex -> /nix/store/v8y8nbsc8f964bab7q4ars30avh80mvj-ergodoxez-factory.hex
├── build-model01-builtin-shajra-flash -> /nix/store/mka6177pwirfbnw41r5fvpxn53ladq97-model01-builtin-shajra-flash
├── build-model01-builtin-shajra-hex -> /nix/store/wgy2rg9cr9zr1r5vshsbw462bdm96ps8-model01-builtin-shajra-hex
├── build-model01-factory-flash -> /nix/store/n2b3c6i1llq968lapajg2614508rmp0s-model01-factory-flash
├── build-model01-factory-hex -> /nix/store/w1zphfpkb09jrijxdppw1f38fvp4ypk1-model01-factory-hex
├── build-model100-builtin-shajra-flash -> /nix/store/p5zaz7mk83lsn9yyyy3rwq4wjyjghbmh-model100-builtin-shajra-flash
├── build-model100-builtin-shajra-hex -> /nix/store/admxy34rly5hnvswzlfn1gchc76hjqzp-model100-builtin-shajra-hex
├── build-model100-factory-flash -> /nix/store/g3pdl1yiy4qmza55kbccdsqfcpdsc35s-model100-factory-flash
├── build-model100-factory-hex -> /nix/store/q7aw2sb6nxq4sfbvm254kmpyjyczai4d-model100-factory-hex
├── build-moonlander-builtin-shajra-flash -> /nix/store/0nlv0y2204ksg68ir39h0sg7z3kmyhcc-moonlander-builtin-shajra-flash
├── build-moonlander-builtin-shajra-hex -> /nix/store/js2yvr01sz5zs2k84f6mh3nn208pna0k-moonlander-builtin-shajra.bin
├── build-moonlander-factory-flash -> /nix/store/d92zdnx8l2mpx33klrvjnmdjs3lwylfi-moonlander-factory-flash
├── build-moonlander-factory-hex -> /nix/store/1206ymbcancln1nqxd7ihv8hpn0ndf81-moonlander-factory.bin
├── flash-ergodoxez -> /nix/store/7fafz6grzpykq8cr24mbfiy80vhas4cp-flash-ergodoxez
├── flash-model01 -> /nix/store/idgdh21zkabv1l4wvskk95jscimczflz-flash-model01
├── flash-model100 -> /nix/store/fx2yhwgk3ipnjk9w2hvx15w6z4m1p7n4-flash-model100
├── flash-moonlander -> /nix/store/52qwin8wwh8c43d1snwvpd21i6jk0hkr-flash-moonlander
└── licenses -> /nix/store/6nryh742rmj5xpn8ikgwdlq5xsn9nkr0-shajra-keyboards-licenses
/nix/store/j519fbc01biiyyls5vml7j5gl3shz15h-shajra-keyboards-ci
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/bpjx6w5518zpffrxlyg15kyb16wj09wn-ergodoxez-builtin-shajra-flash
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/fs9vidzncsqw4yqfk0xk9glpbpkvkmxj-ergodoxez-builtin-shajra.hex
├── build-ergodoxez-factory-flash -> /nix/store/rn37y0mhlyc4xmg733w9vhk3szmkhwka-ergodoxez-factory-flash
├── build-ergodoxez-factory-hex -> /nix/store/prh122s46z8ygdkwbq04jmanhcc7mas3-ergodoxez-factory.hex
├── build-model01-builtin-shajra-flash -> /nix/store/92gg30iwx8sd85p04i77hiqdgg5yvkij-model01-builtin-shajra-flash
├── build-model01-builtin-shajra-hex -> /nix/store/nijc9bqfprkyvb279qczqc9v9nmmm0ni-model01-builtin-shajra-hex
├── build-model01-factory-flash -> /nix/store/5n2r6pcb0d8z8qnmgbyhfs8kb2k5rcsm-model01-factory-flash
├── build-model01-factory-hex -> /nix/store/kkfrx4mfmiyc7r2klb61yxkg83w6lfi2-model01-factory-hex
├── build-model100-builtin-shajra-flash -> /nix/store/6n45v1fpbm1bnr6higj5afc905qzrp3q-model100-builtin-shajra-flash
├── build-model100-builtin-shajra-hex -> /nix/store/53zgxwavx7hzbh5y3y24np1cgc026kiw-model100-builtin-shajra-hex
├── build-model100-factory-flash -> /nix/store/wf853l76qjjqmhal5i1cbraz39v1jgjp-model100-factory-flash
├── build-model100-factory-hex -> /nix/store/wiw7j9c1fixvkk1q8ndfsdh070yhqdk4-model100-factory-hex
├── build-moonlander-builtin-shajra-flash -> /nix/store/ck7r2iy0zcmx2vd47wif5yjb4a74pqki-moonlander-builtin-shajra-flash
├── build-moonlander-builtin-shajra-hex -> /nix/store/s1jy7b079lhrca05hv5kbbrs2m2p412x-moonlander-builtin-shajra.bin
├── build-moonlander-factory-flash -> /nix/store/pxv1fsjk9mmav61f8k2k6drbbl4kk5bs-moonlander-factory-flash
├── build-moonlander-factory-hex -> /nix/store/fcqjr5i2pyfi17cw4x64lxyagh0wfz68-moonlander-factory.bin
├── flash-ergodoxez -> /nix/store/cm31va3absqlhf7qwmn2z1z31fiia27m-flash-ergodoxez
├── flash-model01 -> /nix/store/6wd25bgqvlf2ivgr3vnj52lhmmnnr4il-flash-model01
├── flash-model100 -> /nix/store/hrz4rw4fmyivllm7gkajs0h2g81gnj0c-flash-model100
├── flash-moonlander -> /nix/store/q1d8q4avyxpyic3pqzh3myi00xgckcpn-flash-moonlander
└── licenses -> /nix/store/v1vr721kj917f0skg3sy1jzp6gjh2nkv-shajra-keyboards-licenses

18 directories, 4 files
#+end_example
Expand Down
10 changes: 5 additions & 5 deletions doc/nix-usage-flakes.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ nix search nixpkgs 'gpu|opengl|accel' terminal
* legacyPackages.x86_64-linux.kitty (0.31.0)
A modern, hackable, featureful, OpenGL based terminal emulator

* legacyPackages.x86_64-linux.rio (0.0.32)
* legacyPackages.x86_64-linux.rio (0.0.33)
A hardware-accelerated GPU terminal emulator powered by WebGPU

* legacyPackages.x86_64-linux.wezterm (20230712-072601-f4abf8fd)
Expand Down Expand Up @@ -257,7 +257,7 @@ After a successful call of `nix build`, you'll see one or more symlinks for each
readlink result*
```

/nix/store/6nryh742rmj5xpn8ikgwdlq5xsn9nkr0-shajra-keyboards-licenses
/nix/store/v1vr721kj917f0skg3sy1jzp6gjh2nkv-shajra-keyboards-licenses

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

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

/nix/store/6nryh742rmj5xpn8ikgwdlq5xsn9nkr0-shajra-keyboards-licenses
/nix/store/v1vr721kj917f0skg3sy1jzp6gjh2nkv-shajra-keyboards-licenses

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

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

/nix/store/6nryh742rmj5xpn8ikgwdlq5xsn9nkr0-shajra-keyboards-licenses/bin/shajra-keyboards-licenses
/nix/store/v1vr721kj917f0skg3sy1jzp6gjh2nkv-shajra-keyboards-licenses/bin/shajra-keyboards-licenses

This is all a consequence of everything discussed in previous sections, but it's good to see clearly that what we do with local flake references can work just as well with remote flake references.

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

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

Expand Down
10 changes: 5 additions & 5 deletions doc/nix-usage-flakes.org
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ nix search nixpkgs 'gpu|opengl|accel' terminal | ansifilter
,* legacyPackages.x86_64-linux.kitty (0.31.0)
A modern, hackable, featureful, OpenGL based terminal emulator

,* legacyPackages.x86_64-linux.rio (0.0.32)
,* legacyPackages.x86_64-linux.rio (0.0.33)
A hardware-accelerated GPU terminal emulator powered by WebGPU

,* legacyPackages.x86_64-linux.wezterm (20230712-072601-f4abf8fd)
Expand Down Expand Up @@ -442,7 +442,7 @@ readlink result*
#+end_src

#+RESULTS: nix-build-link
: /nix/store/6nryh742rmj5xpn8ikgwdlq5xsn9nkr0-shajra-keyboards-licenses
: /nix/store/v1vr721kj917f0skg3sy1jzp6gjh2nkv-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/6nryh742rmj5xpn8ikgwdlq5xsn9nkr0-shajra-keyboards-licenses
: /nix/store/v1vr721kj917f0skg3sy1jzp6gjh2nkv-shajra-keyboards-licenses

** Running commands in a shell

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

#+RESULTS: nix-shell-remote
: /nix/store/6nryh742rmj5xpn8ikgwdlq5xsn9nkr0-shajra-keyboards-licenses/bin/shajra-keyboards-licenses
: /nix/store/v1vr721kj917f0skg3sy1jzp6gjh2nkv-shajra-keyboards-licenses/bin/shajra-keyboards-licenses

This is all a consequence of everything discussed in previous sections, but it's
good to see clearly that what we do with local flake references can work just as
Expand Down Expand Up @@ -683,7 +683,7 @@ nix profile list --profile /tmp/nix-profile
: Flake attribute: packages.x86_64-linux.licenses-thirdparty
: Original flake URL: git+file:///home/tnks/src/shajra/shajra-keyboards
: Locked flake URL: git+file:///home/tnks/src/shajra/shajra-keyboards
: Store paths: /nix/store/6nryh742rmj5xpn8ikgwdlq5xsn9nkr0-shajra-keyboards-licenses
: Store paths: /nix/store/v1vr721kj917f0skg3sy1jzp6gjh2nkv-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 4184e90

Please sign in to comment.