History

prescientmoon 9b089af081 Add support for paddings and rounded corners		2024-02-21 05:01:46 +01:00
..
scripts	Fix tiny comment	2023-10-22 17:24:28 +02:00
src	Add support for paddings and rounded corners	2024-02-21 05:01:46 +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	Add docs and layout auto-generation	2023-10-22 16:39:55 +02:00
shell.nix	Clean up the layout renderer!	2023-10-22 16:10:53 +02:00

README.md

Layout-lens

NOTE: this project cannot yet render combos, which will change soon

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

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.