Extended the hint of the programmer to link to the relevant README part instead of...

[qmk_firmware.git] / keyboards / xd75 / readme.md

diff --git a/keyboards/xd75/readme.md b/keyboards/xd75/readme.md
index 126320872908f2a0f0bd2b2d908771e481ec0afa..5f4d2e85ffe46686bcabea771162dda5fc00162b 100644 (file)
--- a/keyboards/xd75/readme.md
+++ b/keyboards/xd75/readme.md
@@ -1,28 +1,47 @@
 xd75 keyboard firmware
 ======================
 
+The XD75Re is a 15x5 full-grid ortholinear keyboard manufactured by XIUDI. This port of the QMK firmware is my first shot at using QMK, so if you see any features done wrong (or just plain missing), feel free to fix them and put in a pull request!
+
 ## Quantum MK Firmware
 
-For the full Quantum feature list, see [the parent readme](/).
+For more info on this firmware (and how to make it your own), head over to [qmk.fm](http://qmk.fm).
 
 ## Building
 
-Download or clone the whole firmware and navigate to the keyboards/xd75 folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file. 
-
-Depending on which keymap you would like to use, you will have to compile slightly differently.
+Download or clone the whole firmware and navigate to the
+keyboards/xd75 folder. Once your dev env is setup, you'll be able to
+type `make` to generate your .hex - you can then use the Teensy Loader
+to install the resulting .hex file, or have the `make` process install
+it using DFU.
 
 ### Default
 
-To build with the default keymap, simply run `make default`.
+To build with the default keymap, simply run `make xd75:default` from the root directory (i.e. two levels above this file), and to install via DFU, `make xd75:default:dfu`, also from the root directory.
+
+Note that DFU is likely to require root permissions, so installing the
+firmware likely requires a command line like:
+
+```
+$ sudo make xd75:default:dfu
+```
 
 ### Other Keymaps
 
-Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant keymap files.
+The "default" keymap included is basically the OLKB Atomic keymap with
+a few buttons added for RGB underglow control. This should be usable
+as a starting point, but most people will be best served creating
+their own keymap and flashing it - more info on creating your own
+keymap is available in [the official QMK
+documentation](https://docs.qmk.fm).
+
+Keymaps follow the format **__\<name\>.c__** and are stored in
+subdirectories under `keyboards/xd75/keymaps`
 
-To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
+To build the firmware binary hex file for a specific keymap, and
+install it, using DFU, just do `make` with a keymap like this:
 
 ```
-$ make [default|jack|<name>]
+$ make xd75:[default|<name>]
 ```
 
-Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.