summaryrefslogtreecommitdiff
path: root/keyboards/ymdk/ymd96/keymaps/AnthonyWharton/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ymdk/ymd96/keymaps/AnthonyWharton/README.md')
-rw-r--r--keyboards/ymdk/ymd96/keymaps/AnthonyWharton/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/keyboards/ymdk/ymd96/keymaps/AnthonyWharton/README.md b/keyboards/ymdk/ymd96/keymaps/AnthonyWharton/README.md
new file mode 100644
index 0000000000..973e336cb6
--- /dev/null
+++ b/keyboards/ymdk/ymd96/keymaps/AnthonyWharton/README.md
@@ -0,0 +1,16 @@
+# Personal Config by @AnthonyWharton
+
+The keymap and layout macro's in the main repository are for the following
+keyboard:
+
+![@AnthonyWharton's YMD96](https://i.imgur.com/uhKmkBz.jpg)
+
+**Note:** This setup has locking Caps Lock and Num Lock keys, so if you wish
+to use this layout and do not have such keys, you should :
+
+ - Change the keys `KC_LCAP` and `KC_LNUM` to `KC_CAPS` and `KC_NUMLOCK`
+ respectively.
+ - Remove the `LOCKING_SUPPORT_ENABLE` and `LOCKING_RESYNC_ENABLE` lines
+ from `config.h`.
+
+For any other questions, find my latest contact information on my github page.