diff --git a/README.md b/README.md index bc69e36..11f3a18 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,16 @@ A window manager written in [Rust](https://rust-lang.org). ## Contributing Please contribute, we don't know what the fuck we are doing. How we even got to this point is beyond us. + +### A small side note about the config file and keybinds + +If you wish to set a keybind, you must use a 32-bit unsigned integer value. +These values are pre-defined, and can be found in the `keysymdef.rs` file. +The file is an automatically generated binding from the `keysymdef.h` file +(which can be found at `/usr/include/X11`). Refer to both of these files if +you are having trouble with keybinds. Please note, however, that it is +not a direct binding - the constant names have been trimmed (the prefix `XK_`) +removed, and have been renamed to follow rust constant naming conventions. Some +keysyms (mostly greek ones) have been outright removed, due to me being too lazy +to bother with renaming them all in order to not have conflicts. +> `hungl was here` \ No newline at end of file