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 Jul 15, 2024
1 parent 1bb87bc commit 1c43bed
Show file tree
Hide file tree
Showing 7 changed files with 80 additions and 80 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/1ah1jp68w7kfry630i13c0mlinz2rncs-qmk-builtin-shajra-src
FLASH BINARY: /nix/store/1l9l2jskv3ak0vg4hnb8vhrp8ak6cdhy-ergodoxez-builtin-shajra.hex
FLASH SOURCE: /nix/store/6pjngynz6x6yn6djy4cd8kfwz69lryn3-qmk-builtin-shajra-src
FLASH BINARY: /nix/store/wx45dcml68gjqidvz4c7y5gqpivmfcd6-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/ljnwl55c115birn4nzzwifd7fign0hg3-shajra-keyboards-ci
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/rggmy8wcjamm2z7bf0dlfhbhxk2harxa-ergodoxez-builtin-shajra-flash
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/1l9l2jskv3ak0vg4hnb8vhrp8ak6cdhy-ergodoxez-builtin-shajra.hex
├── build-ergodoxez-factory-flash -> /nix/store/z8acs1vhc6cd9hkldpdmjranzni391r7-ergodoxez-factory-flash
├── build-ergodoxez-factory-hex -> /nix/store/cbmxzxgn9hrdwnjry5afj40kvii2vx5h-ergodoxez-factory.hex
├── build-model01-builtin-shajra-flash -> /nix/store/mwbksqhbm8ms2z77505v59m348gh4iz2-model01-builtin-shajra-flash
├── build-model01-builtin-shajra-hex -> /nix/store/dn0r0dfmdk69qi41hi7yj6qc2jnkdpj5-model01-builtin-shajra-hex
├── build-model01-factory-flash -> /nix/store/562lgm0hg9as3kgc7afryqphsf8zr3lc-model01-factory-flash
├── build-model01-factory-hex -> /nix/store/yysvcxa0bkahg3aaxa3wf39w47kkxg6k-model01-factory-hex
├── build-model100-builtin-shajra-flash -> /nix/store/9vyr53zsksi4hsqkbmz96llph4f7p9xx-model100-builtin-shajra-flash
├── build-model100-builtin-shajra-hex -> /nix/store/xjx8w717hkci7jx03r4qr91flb1dfipx-model100-builtin-shajra-hex
├── build-model100-factory-flash -> /nix/store/yqyx3fa2aaiib9r16czybyk0ffvq7f9m-model100-factory-flash
├── build-model100-factory-hex -> /nix/store/mkf9q6c2na4r6cyn62yirqrda7ynpdkp-model100-factory-hex
├── build-moonlander-builtin-shajra-flash -> /nix/store/89cykmx50c9n1nfgi2p0vgqsjl9rdvba-moonlander-builtin-shajra-flash
├── build-moonlander-builtin-shajra-hex -> /nix/store/1k4mvaph1g9zbxj040v1f67zgzfhj5hq-moonlander-builtin-shajra.bin
├── build-moonlander-factory-flash -> /nix/store/mhwdv0inx96bf7qhi0w3cziq6i754ddc-moonlander-factory-flash
├── build-moonlander-factory-hex -> /nix/store/c0jmds3ycviyqj9xd5g2018zq6y61bsd-moonlander-factory.bin
├── flash-ergodoxez -> /nix/store/2nfk6ayadixpjabdnjzrv87lzb9fkxf3-flash-ergodoxez
├── flash-model01 -> /nix/store/21khrzwpyjhph22d9f9jz3kx2lspydrz-flash-model01
├── flash-model100 -> /nix/store/64g0lrjq1my2gbgymi4d7g4kkki6vffw-flash-model100
├── flash-moonlander -> /nix/store/m42pwy5fr79w1pdd19yzygr45iqlm6md-flash-moonlander
└── licenses -> /nix/store/w8qmd8pj3ia7d1w7rw5rybpzz0sc73py-shajra-keyboards-licenses
/nix/store/wmfgrlxp4iy61cs8irmmzhi1h4qmgja9-shajra-keyboards-ci
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/fj94x1d59wjjing8q3mcigb9a29kaavy-ergodoxez-builtin-shajra-flash
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/wx45dcml68gjqidvz4c7y5gqpivmfcd6-ergodoxez-builtin-shajra.hex
├── build-ergodoxez-factory-flash -> /nix/store/r4hggnsyvr0nbsgw6b644z6xb0wr3dhg-ergodoxez-factory-flash
├── build-ergodoxez-factory-hex -> /nix/store/z92bgwlkilqx0gqn2ippz0nsvpvq2g64-ergodoxez-factory.hex
├── build-model01-builtin-shajra-flash -> /nix/store/af3lxn5v37plbl8bd19kz2y7v1vpmhmf-model01-builtin-shajra-flash
├── build-model01-builtin-shajra-hex -> /nix/store/vf5y2kf1qc7hw5jjlw2yfxmdzfabpc5m-model01-builtin-shajra-hex
├── build-model01-factory-flash -> /nix/store/mhc2610zh9sqbbx3sa54fgmjrxs65kgd-model01-factory-flash
├── build-model01-factory-hex -> /nix/store/s3a8f8m1qcm97i92djkrpwrgkg0wk0js-model01-factory-hex
├── build-model100-builtin-shajra-flash -> /nix/store/3p1vgy6xlkshqdpjrck0jchbwvkr0wma-model100-builtin-shajra-flash
├── build-model100-builtin-shajra-hex -> /nix/store/4j2b1nkdgcis3h90d0fq2s1nc5lr7h03-model100-builtin-shajra-hex
├── build-model100-factory-flash -> /nix/store/cpb883vv9cdxy3l2n8kzn8d33vnq3nr4-model100-factory-flash
├── build-model100-factory-hex -> /nix/store/77yaiax9p92in5s89fg05p7f2f2pyim9-model100-factory-hex
├── build-moonlander-builtin-shajra-flash -> /nix/store/l5irmqr6injbrnc1awn0yx1gdr1wxq3g-moonlander-builtin-shajra-flash
├── build-moonlander-builtin-shajra-hex -> /nix/store/ihxn8nh5pvgiwsbd3asds5n3zaraq24h-moonlander-builtin-shajra.bin
├── build-moonlander-factory-flash -> /nix/store/423r0y2hdwsxmjq6fy746aifjsygynqn-moonlander-factory-flash
├── build-moonlander-factory-hex -> /nix/store/ayf6yr8nbnfrf9hfgp6sl3gf78x2w0nk-moonlander-factory.bin
├── flash-ergodoxez -> /nix/store/7y7srw0w79q708c2wf8gkkbdad6x9zk5-flash-ergodoxez
├── flash-model01 -> /nix/store/c4z2fs12bmy4c1jcjcb01r6lk25i46wv-flash-model01
├── flash-model100 -> /nix/store/i6zi8wk7k3qdcxjbj3jj7ynzql453sl4-flash-model100
├── flash-moonlander -> /nix/store/13vf8idinc22gfd4kn9qqh7kf0d0zxzx-flash-moonlander
└── licenses -> /nix/store/2m2mxyx1sv3yq82qih3b9fzjc94nsyih-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/1ah1jp68w7kfry630i13c0mlinz2rncs-qmk-builtin-shajra-src
: FLASH BINARY: /nix/store/1l9l2jskv3ak0vg4hnb8vhrp8ak6cdhy-ergodoxez-builtin-shajra.hex
: FLASH SOURCE: /nix/store/6pjngynz6x6yn6djy4cd8kfwz69lryn3-qmk-builtin-shajra-src
: FLASH BINARY: /nix/store/wx45dcml68gjqidvz4c7y5gqpivmfcd6-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/ljnwl55c115birn4nzzwifd7fign0hg3-shajra-keyboards-ci
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/rggmy8wcjamm2z7bf0dlfhbhxk2harxa-ergodoxez-builtin-shajra-flash
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/1l9l2jskv3ak0vg4hnb8vhrp8ak6cdhy-ergodoxez-builtin-shajra.hex
├── build-ergodoxez-factory-flash -> /nix/store/z8acs1vhc6cd9hkldpdmjranzni391r7-ergodoxez-factory-flash
├── build-ergodoxez-factory-hex -> /nix/store/cbmxzxgn9hrdwnjry5afj40kvii2vx5h-ergodoxez-factory.hex
├── build-model01-builtin-shajra-flash -> /nix/store/mwbksqhbm8ms2z77505v59m348gh4iz2-model01-builtin-shajra-flash
├── build-model01-builtin-shajra-hex -> /nix/store/dn0r0dfmdk69qi41hi7yj6qc2jnkdpj5-model01-builtin-shajra-hex
├── build-model01-factory-flash -> /nix/store/562lgm0hg9as3kgc7afryqphsf8zr3lc-model01-factory-flash
├── build-model01-factory-hex -> /nix/store/yysvcxa0bkahg3aaxa3wf39w47kkxg6k-model01-factory-hex
├── build-model100-builtin-shajra-flash -> /nix/store/9vyr53zsksi4hsqkbmz96llph4f7p9xx-model100-builtin-shajra-flash
├── build-model100-builtin-shajra-hex -> /nix/store/xjx8w717hkci7jx03r4qr91flb1dfipx-model100-builtin-shajra-hex
├── build-model100-factory-flash -> /nix/store/yqyx3fa2aaiib9r16czybyk0ffvq7f9m-model100-factory-flash
├── build-model100-factory-hex -> /nix/store/mkf9q6c2na4r6cyn62yirqrda7ynpdkp-model100-factory-hex
├── build-moonlander-builtin-shajra-flash -> /nix/store/89cykmx50c9n1nfgi2p0vgqsjl9rdvba-moonlander-builtin-shajra-flash
├── build-moonlander-builtin-shajra-hex -> /nix/store/1k4mvaph1g9zbxj040v1f67zgzfhj5hq-moonlander-builtin-shajra.bin
├── build-moonlander-factory-flash -> /nix/store/mhwdv0inx96bf7qhi0w3cziq6i754ddc-moonlander-factory-flash
├── build-moonlander-factory-hex -> /nix/store/c0jmds3ycviyqj9xd5g2018zq6y61bsd-moonlander-factory.bin
├── flash-ergodoxez -> /nix/store/2nfk6ayadixpjabdnjzrv87lzb9fkxf3-flash-ergodoxez
├── flash-model01 -> /nix/store/21khrzwpyjhph22d9f9jz3kx2lspydrz-flash-model01
├── flash-model100 -> /nix/store/64g0lrjq1my2gbgymi4d7g4kkki6vffw-flash-model100
├── flash-moonlander -> /nix/store/m42pwy5fr79w1pdd19yzygr45iqlm6md-flash-moonlander
└── licenses -> /nix/store/w8qmd8pj3ia7d1w7rw5rybpzz0sc73py-shajra-keyboards-licenses
/nix/store/wmfgrlxp4iy61cs8irmmzhi1h4qmgja9-shajra-keyboards-ci
├── build-ergodoxez-builtin-shajra-flash -> /nix/store/fj94x1d59wjjing8q3mcigb9a29kaavy-ergodoxez-builtin-shajra-flash
├── build-ergodoxez-builtin-shajra-hex -> /nix/store/wx45dcml68gjqidvz4c7y5gqpivmfcd6-ergodoxez-builtin-shajra.hex
├── build-ergodoxez-factory-flash -> /nix/store/r4hggnsyvr0nbsgw6b644z6xb0wr3dhg-ergodoxez-factory-flash
├── build-ergodoxez-factory-hex -> /nix/store/z92bgwlkilqx0gqn2ippz0nsvpvq2g64-ergodoxez-factory.hex
├── build-model01-builtin-shajra-flash -> /nix/store/af3lxn5v37plbl8bd19kz2y7v1vpmhmf-model01-builtin-shajra-flash
├── build-model01-builtin-shajra-hex -> /nix/store/vf5y2kf1qc7hw5jjlw2yfxmdzfabpc5m-model01-builtin-shajra-hex
├── build-model01-factory-flash -> /nix/store/mhc2610zh9sqbbx3sa54fgmjrxs65kgd-model01-factory-flash
├── build-model01-factory-hex -> /nix/store/s3a8f8m1qcm97i92djkrpwrgkg0wk0js-model01-factory-hex
├── build-model100-builtin-shajra-flash -> /nix/store/3p1vgy6xlkshqdpjrck0jchbwvkr0wma-model100-builtin-shajra-flash
├── build-model100-builtin-shajra-hex -> /nix/store/4j2b1nkdgcis3h90d0fq2s1nc5lr7h03-model100-builtin-shajra-hex
├── build-model100-factory-flash -> /nix/store/cpb883vv9cdxy3l2n8kzn8d33vnq3nr4-model100-factory-flash
├── build-model100-factory-hex -> /nix/store/77yaiax9p92in5s89fg05p7f2f2pyim9-model100-factory-hex
├── build-moonlander-builtin-shajra-flash -> /nix/store/l5irmqr6injbrnc1awn0yx1gdr1wxq3g-moonlander-builtin-shajra-flash
├── build-moonlander-builtin-shajra-hex -> /nix/store/ihxn8nh5pvgiwsbd3asds5n3zaraq24h-moonlander-builtin-shajra.bin
├── build-moonlander-factory-flash -> /nix/store/423r0y2hdwsxmjq6fy746aifjsygynqn-moonlander-factory-flash
├── build-moonlander-factory-hex -> /nix/store/ayf6yr8nbnfrf9hfgp6sl3gf78x2w0nk-moonlander-factory.bin
├── flash-ergodoxez -> /nix/store/7y7srw0w79q708c2wf8gkkbdad6x9zk5-flash-ergodoxez
├── flash-model01 -> /nix/store/c4z2fs12bmy4c1jcjcb01r6lk25i46wv-flash-model01
├── flash-model100 -> /nix/store/i6zi8wk7k3qdcxjbj3jj7ynzql453sl4-flash-model100
├── flash-moonlander -> /nix/store/13vf8idinc22gfd4kn9qqh7kf0d0zxzx-flash-moonlander
└── licenses -> /nix/store/2m2mxyx1sv3yq82qih3b9fzjc94nsyih-shajra-keyboards-licenses

18 directories, 4 files
#+end_example
Expand Down
2 changes: 0 additions & 2 deletions doc/nix-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,6 @@ For each substituter we use, we need to also configure Nix to trust their public

When editing the `/etc/nix/nix.conf` as root, suffix the new substituter(s), space-separated to any values already populating the `substituters` parameter.

Note, the order of the substituters indicates the order in which caches are searched. Leave the <https://cache.nixos.org> substituter first to maximize cache hits.

Next, similarly suffix the key(s) to the `trusted-public-keys` parameter.

Your file will likely look like the following:
Expand Down
4 changes: 0 additions & 4 deletions doc/nix-installation.org
Original file line number Diff line number Diff line change
Expand Up @@ -133,10 +133,6 @@ keys:
When editing the =/etc/nix/nix.conf= as root, suffix the new substituter(s),
space-separated to any values already populating the =substituters= parameter.

Note, the order of the substituters indicates the order in which caches are
searched. Leave the https://cache.nixos.org substituter first to maximize cache
hits.

Next, similarly suffix the key(s) to the =trusted-public-keys= parameter.

Your file will likely look like the following:
Expand Down
13 changes: 8 additions & 5 deletions doc/nix-usage-flakes.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,12 +108,15 @@ nix flake show .
git+file:///home/shajra/src/shajra-keyboards
├───apps
│ └───x86_64-linux
│ ├───default: app
│ ├───flash-ergodoxez: app
│ ├───flash-model01: app
│ ├───flash-model100: app
│ ├───flash-moonlander: app
│ └───licenses-thirdparty: app
├───checks
│ └───x86_64-linux
│ └───ci: derivation 'shajra-keyboards-ci'
├───legacyPackages
│ └───x86_64-linux omitted (use '--legacy' to show)
├───overlays
Expand Down Expand Up @@ -262,7 +265,7 @@ After a successful call of `nix build`, you'll see one or more symlinks for each
readlink result*
```

/nix/store/w8qmd8pj3ia7d1w7rw5rybpzz0sc73py-shajra-keyboards-licenses
/nix/store/2m2mxyx1sv3yq82qih3b9fzjc94nsyih-shajra-keyboards-licenses

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

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

/nix/store/w8qmd8pj3ia7d1w7rw5rybpzz0sc73py-shajra-keyboards-licenses
/nix/store/2m2mxyx1sv3yq82qih3b9fzjc94nsyih-shajra-keyboards-licenses

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

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

/nix/store/w8qmd8pj3ia7d1w7rw5rybpzz0sc73py-shajra-keyboards-licenses/bin/shajra-keyboards-licenses
/nix/store/2m2mxyx1sv3yq82qih3b9fzjc94nsyih-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 +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/w8qmd8pj3ia7d1w7rw5rybpzz0sc73py-shajra-keyboards-licenses
Store paths: /nix/store/2m2mxyx1sv3yq82qih3b9fzjc94nsyih-shajra-keyboards-licenses

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

Expand Down
13 changes: 8 additions & 5 deletions doc/nix-usage-flakes.org
Original file line number Diff line number Diff line change
Expand Up @@ -202,12 +202,15 @@ nix flake show . | ansifilter
git+file:///home/shajra/src/shajra-keyboards
├───apps
│ └───x86_64-linux
│ ├───default: app
│ ├───flash-ergodoxez: app
│ ├───flash-model01: app
│ ├───flash-model100: app
│ ├───flash-moonlander: app
│ └───licenses-thirdparty: app
├───checks
│ └───x86_64-linux
│ └───ci: derivation 'shajra-keyboards-ci'
├───legacyPackages
│ └───x86_64-linux omitted (use '--legacy' to show)
├───overlays
Expand Down Expand Up @@ -442,7 +445,7 @@ readlink result*
#+end_src

#+RESULTS: nix-build-link
: /nix/store/w8qmd8pj3ia7d1w7rw5rybpzz0sc73py-shajra-keyboards-licenses
: /nix/store/2m2mxyx1sv3yq82qih3b9fzjc94nsyih-shajra-keyboards-licenses

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

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

#+results: nix-build-path
: /nix/store/w8qmd8pj3ia7d1w7rw5rybpzz0sc73py-shajra-keyboards-licenses
: /nix/store/2m2mxyx1sv3yq82qih3b9fzjc94nsyih-shajra-keyboards-licenses

** Running commands in a shell

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

#+RESULTS: nix-shell-remote
: /nix/store/w8qmd8pj3ia7d1w7rw5rybpzz0sc73py-shajra-keyboards-licenses/bin/shajra-keyboards-licenses
: /nix/store/2m2mxyx1sv3yq82qih3b9fzjc94nsyih-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 +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/w8qmd8pj3ia7d1w7rw5rybpzz0sc73py-shajra-keyboards-licenses
: Store paths: /nix/store/2m2mxyx1sv3yq82qih3b9fzjc94nsyih-shajra-keyboards-licenses

If we want to uninstall a program from our profile, we do so by the index from
this list:
Expand Down
32 changes: 16 additions & 16 deletions flake.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 1c43bed

Please sign in to comment.