1
Fork 0
keyswirl/layout-lens
2024-02-21 08:47:15 +01:00
..
scripts Fix tiny comment 2023-10-22 17:24:28 +02:00
src Tweak rendering 2024-02-21 08:47:15 +01:00
.gitignore Clean up the layout renderer! 2023-10-22 16:10:53 +02:00
default.nix Add docs and layout auto-generation 2023-10-22 16:39:55 +02:00
package-lock.json Add docs and layout auto-generation 2023-10-22 16:39:55 +02:00
package.json Add docs and layout auto-generation 2023-10-22 16:39:55 +02:00
README.md Vizualise chords 2024-02-21 08:32:04 +01:00
shell.nix Clean up the layout renderer! 2023-10-22 16:10:53 +02:00

Layout-lens

This is a quickly-thrown-together set of scripts for generating SVG previews of keyboard layouts. For example configurations check out any config in the keyboards directory of this repository. To run this on your config simply do

nix run github:mateiadrielrafael/keyswirl#layout-lens my-config.json out.svg

Future improvements

This project does not render chords involving rotated keys properly. Moreover, chord definitions in general can be a little verboose.

Technical details

The code isn't very well written (i.e.: no error handling, only contains the features I needed myself, etc). I'd rewrite this in a better language given the motivation, but the current version does the job just fine. If you want to contribute a layout preset, add it to ./src/layouts and then modify the enum in ./src/types.ts to know about it's existence.