Add README.md

This commit is contained in:
The Magician 2023-12-19 11:06:14 +00:00
parent c10a7d31d6
commit 06f4eed668
1 changed files with 16 additions and 0 deletions

16
README.md Normal file
View File

@ -0,0 +1,16 @@
# 40percent
Keymap files for my 40% size keyboard.
## X11
`40percent` is the X11 keymap; this is a modified version of the `en_US` keymap with the `"` and `@` symbols switched.
Caps Lock is set to Escape via `setxkbmap -option caps:swapescape 40percent` in my [`.xinitrc`](https://git.themagician.cc/TheMagician/stow/src/branch/main/X/.xinitrc) file.
## Console
`40percent.map` is the console keymap.
It's a modified version of the `uk` keymap with the Caps Lock keysym changed to generate an Escape.
It's used by setting `keymap="40percent"` in `/etc/conf.d/keymaps` (on Gentoo).
## Installation
Use `make install-x11` to install the X11 keymap and `make install-console` to install the console keymap.
Installation requires root access to write to the `/usr` tree.