See the kbdgen User Manual!
As of version 2.0, kbdgen is written in a combination of Rust and Python. PyOxidizer is used to bundle a Python interpreter in the Rust binary so end users don’t have to concern themselves with installing additional dependencies.
-
Install the latest stable Rust version using Rustup
-
Install pyoxidizer:
-
Make sure you have a C compiler, usual build tools like Make, and probably also openssl headers installed, so you can compile the Python interpreter and its standard library.
-
Install the pyoxidizer version. The quickest way is using
cargo install pyoxidizer --vers 0.7.0.
-
-
Build the project using
cargo build.
The kbdgen User Manual can be found in docs/
and is written in AsciiDoc.
To render it,
install Asciidoctor,
run gem install coderay,
go into the docs/ directory,
and run asciidoctor --verbose index.adoc .
|
Note
|
Some parts of the documentation are actually automatically generated
by using a special derive macro on some structs.
See ./derive-collect-docs for more information.
|
Licensed under either of
-
Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
-
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.