使用cargo install：

cargo install kanata

# 在Linux和macOS上，如果没有`sudo`可能无法运行，请参见下文
kanata --cfg <您的配置文件>

在Linux上构建和运行：

git clone https://github.com/jtroo/kanata && cd kanata
cargo build   # 可选择添加--release，性能并不是特别敏感

# 使用sudo是因为kanata需要打开/dev/文件
#
# 如果您想避免使用sudo，请参见：
# https://github.com/jtroo/kanata/wiki/Avoid-using-sudo-on-Linux
sudo target/debug/kanata --cfg <您的配置文件>

在Windows上构建和运行：

git clone https://github.com/jtroo/kanata; cd kanata
cargo build   # 可选择添加--release，性能并不是特别敏感
target\debug\kanata --cfg <您的配置文件>

在macOS上构建和运行：

对于macOS 11及更新版本：安装Karabiner VirtualHiDDevice驱动程序。

激活它：

/Applications/.Karabiner-VirtualHIDDevice-Manager.app/Contents/MacOS/Karabiner-VirtualHIDDevice-Manager activate

对于macOS 10及更早版本： 安装Karabiner内核扩展。

git clone https://github.com/jtroo/kanata && cd kanata
cargo build   # 可选择添加--release，性能并不是特别敏感

# 需要sudo来获取拦截键盘的权限

sudo target/debug/kanata --cfg <您的配置文件>

完整的配置指南在这里。

示例配置文件位于cfg_samples目录中。simple.kbd文件包含一个基本的配置文件，希望易于理解，但不包含所有功能。kanata.kbd包含所有功能的示例及文档。发布资产中也有一个kanata.kbd文件，经过测试可与该版本一起使用。所有键名可以在keys模块中找到，您也可以定义自己的键名。

如果您想启用cmd操作， 添加标志--features cmd。 例如：

cargo build --release --features cmd
cargo install --features cmd

在Windows上， 如果您想编译使用Interception驱动程序的二进制文件， 您应该添加标志--features interception_driver。 例如：

cargo build --release --features interception_driver
cargo install --features interception_driver

要组合多个标志， 使用单个--features标志， 并用逗号分隔功能。 例如：

cargo build --release --features cmd,interception_driver
cargo install --features cmd,interception_driver

我有几个运行QMK的键盘。QMK允许用户根据自己的喜好自定义键盘功能。

QMK的一个很好的用例是它能够将按键映射到与主行重叠但可在另一层访问的位置。我不评论生产力，但我发现这极大地提高了我的键盘舒适度。

例如，这些键位于键盘的右侧：

7 8 9
u i o
j k l
m , .

在一层上我有相同位置的方向键，在另一层上我有一个数字键盘。

方向键：       数字键盘：
- - -         7 8 9
- ↑ -         4 5 6
← ↓ →         1 2 3
- - -         0 * .

人们可以添加任意多的自定义设置来提高舒适度、速度等。就我个人而言，我的主要动机是舒适度，因为我过去有过重复性劳损。

然而，QMK并不是随处可用。事实上，它在大多数你能得到的硬件上都无法运行。你无法在笔记本电脑键盘或任何主流办公键盘上运行它。我认为QMK提供的舒适度和赋能应该对任何拥有电脑的人在他们现有的硬件上都可用，而不是必须购买一个爱好者机械键盘（诚然，这些键盘非常好——我拥有几个——但可能会很昂贵）。

我发现对于不运行QMK的键盘，最好的替代解决方案是kmonad。这是一个优秀的项目，如果你想尝试类似的东西，我推荐它。

这个项目存在的原因是kmonad是用Haskell编写的，而我不知道如何开始为Haskell项目做贡献。从局外人的角度来看，我认为Haskell是一种很棒的语言，但我真的无法理解它。而且在撰写本文时，还有一些未解决的问题使kmonad对我的个人工作流程来说并不是最优的。

这个项目是用Rust编写的，因为Rust是我最喜欢的编程语言，而且存在优秀的keyberon crate的先前工作。