diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 000000000000..a42b2bed7322 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# kbct + +This is a [PKGBUILD](https://wiki.archlinux.org/title/PKGBUILD) script +for [kbct](https://github.com/samvel1024/kbct) -- keyboard keycode +mapping utility for Linux supporting layered configuration. + +## Installation + +```sh +$ git clone https://aur.archlinux.org/kbct-git.git +$ cd kbct-git +$ makepkg -si +``` + +## Configuration + +The config is expected to be in `/etc/kbct/config.yml`. After you +finish the configuration, you can enable the service: + +```sh +$ systemctl start kbct +``` |