summaryrefslogtreecommitdiff
path: root/keyboards/ergodox/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ergodox/readme.md')
-rw-r--r--keyboards/ergodox/readme.md3
1 files changed, 1 insertions, 2 deletions
diff --git a/keyboards/ergodox/readme.md b/keyboards/ergodox/readme.md
index 3d6fb455a0..618422055f 100644
--- a/keyboards/ergodox/readme.md
+++ b/keyboards/ergodox/readme.md
@@ -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`
@@ -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