aboutsummarylogtreecommitdiffstats
diff options
context:
space:
mode:
authorWilliam Gathoye2017-08-28 11:05:26 +0200
committerWilliam Gathoye2017-08-28 11:05:26 +0200
commit705188329b4aaed6b1e83a3fcc163df7b810345e (patch)
tree0e048c6fa8c4c59dad19a6e6115be2c41e3d5049
parent1907a19722005261e8f2c8c37ac6af46b243310e (diff)
downloadaur-705188329b4aaed6b1e83a3fcc163df7b810345e.tar.gz
Add BBS link and add features section
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index b13db7ddba05..7adf199754e7 100644
--- a/README.md
+++ b/README.md
@@ -9,13 +9,24 @@ From the [keyfuzz help page](http://0pointer.de/lennart/projects/keyfuzz/):
> keyfuzz is not a daemon like Gnome acme which reacts on special hotkeys but a tool to make non-standard keyboards compatible with such daemons. keyfuzz should be run once at boot time, the modifications it makes stay active after the tool quits until reboot. keyfuzz does not interact directly with XFree86. However, newer releases of the latter (4.1 and above) rely on the Linux input API, so they take advantage of the fixed translation tables.
+## Features
+
+* The keyboard is considered as an ISO keyboard (e.g. `<` and `>` located at the right of the `Left Shift` key are working like expected).
+* The function keys are disabled by default. You need to press the `Fn` key in combination to trigger them. The default behavior is keys from `F1` to `F12`.
+* The `Alt` and `Cmd` keys are swapped.
+* `F13` is mapped to `SYSRQ`, `F14` to `Scroll Lock` and `F15` to `Pause`.
+
+The first 3 aforementioned features are brought to you using the default linux kernel module `apple_hid`.
+
+The last one is provided by providing a mapping to ̀keyfuzz`.
+
## Name
[The `un-` prefix is used in English to express the contrary, the opposite, the sense "not"](https://en.wiktionary.org/wiki/un-#English). This is what this package does: with it, your keyboard is not an Apple keyboard anymore.
## License
-This solution was initially written by [Tavian Barnes](https://github.com/tavianator), but I took maintainership of his [AUR package](https://aur.archlinux.org/packages/un-apple-keyboard/) as he is not using an Apple keyboard anymore.
+This solution was initially written by [Tavian Barnes](https://github.com/tavianator), but I took maintainership of his [AUR package](https://aur.archlinux.org/packages/un-apple-keyboard/) as he is not using an Apple keyboard anymore. This project has been initially discussed on [a thread on the Arch Linux forums](https://bbs.archlinux.org/viewtopic.php?id=136439).
[DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE](LICENSE)