#keyboard-layout #keyboard #diagram #layout #graphics #back-end #keycap

keyset

A Rust tool to create pretty keyset layout diagrams using correct fonts and icons

7 releases

0.3.2 Jan 7, 2024
0.3.1 Jan 7, 2024
0.2.1 Aug 21, 2023
0.1.1 May 20, 2023
0.1.0 Mar 30, 2023

#195 in Rendering

47 downloads per month

MIT/Apache

195KB
4K SLoC

keyset.rs   Test StatusTest CoverageCrate VersionRust Version

A (WIP) reimplementation of pykeyset in Rust for improved performance. Eventually this aims to become the backend for pykeyset using a Python wrapper around this project.

Current minimum supported Rust version is 1.70.0, although this is subject to change as development continues.

Installation

First, ensure you have fontTools installed on your system and added to your PATH environment variable. This can be removed afterwards, it is only needed as a build-time dependency.

cargo install keyset

Usage

Coming soon

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

You can install the pre-commit hook (which checks formatting, etc) by running:

pip install -U pre-commit
pre-commit install

Licence

Licensed under either of

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~9–14MB
~175K SLoC