]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - keyboards/ergodox/readme.md
delete old lufa
[qmk_firmware.git] / keyboards / ergodox / readme.md
index 23e5b862daea936142f492fe85809f1f08e50aab..7327087ffef814069e0a94a80f2d2b3f90d3e252 100644 (file)
@@ -25,7 +25,7 @@ If none of the existing keymaps suit you, you can create your own custom
 keymap.  This will require some experience with coding.  Follow these steps
 to customize a keymap:
 
-  - Read the [qmk firmware README](https://github.com/jackhumbert/qmk_firmware) from top to bottom.  Then come back here.  :)
+  - Read the [qmk firmware README](https://github.com/qmk/qmk_firmware) from top to bottom.  Then come back here.  :)
 
   - Clone the qmk_firmware repository
 
@@ -78,7 +78,6 @@ Linux page].  Some distributions provide a binary, maybe called
 To flash the firmware:
 
   - Build the firmware with `make keymapname`, for example `make default`
-
   - This will result in a hex file called `ergodox_ez_keymapname.hex`, e.g.
     `ergodox_ez_default.hex`
 
@@ -95,7 +94,7 @@ To flash with ´teensy-loader-cli´:
 
   - Build the firmware with `make keymapname`, for example `make default`
 
-  - Run ´<path/to/>teensy_loader_cli --mcu=atmega32u4 -w ergodox_ez_<keymap>.hex´
+  - Run ´<path/to/>teensy_loader_cli -mmcu=atmega32u4 -w ergodox_ez_<keymap>.hex´
 
   - Press the Reset button by inserting a paperclip gently into the reset hole
     in the top right corder.
@@ -113,7 +112,7 @@ for the left and right halves seperately.  To flash them:
 
   - Install the firmware with `sudo make infinity-keymapname-dfu-util`
 
-  - Build left hand firmware with `make infinity-keymapname MASTER=right`
+  - Build right hand firmware with `make infinity-keymapname MASTER=right`
 
   - Plug in the right hand keyboard only.
 
@@ -153,7 +152,7 @@ The QMK firmware is open-source, so it would be wonderful to have your contribut
 1. All work goes inside your keymap subdirectory (`keymaps/german` in this example).
 2. `keymap.c` - this is your actual keymap file; please update the ASCII comments in the file so they correspond with what you did.
 3. `readme.md` - a readme file, which GitHub would display by default when people go to your directory. Explain what's different about your keymap, what you tweaked or how it works. No specific format to follow, just communicate what you did. :)
-4. Any graphics you wish to add. This is absolutely not a must. If you feel like it, you can use [Keyboard Layout Editor](http://keyboard-layout-editor.com) to make something and grab a screenshot, but it's really not a must. If you do have graphics, your readme can just embed the graphic as a link, just like I did with the default layout.
+4. Any graphics you wish to add must be hosted elsewhere (please don't include images in your PR). This is absolutely not a must. If you feel like it, you can use [Keyboard Layout Editor](http://keyboard-layout-editor.com) to make something and grab a screenshot, but it's really not a must. If you do have graphics, your readme can just embed the graphic as a link (`![alt-text](url)`), just like I did with the default layout.
 
 # Finding the keycodes you need