From 7f22b67f8ad61f12516ca75acd0d2277b94aa2a5 Mon Sep 17 00:00:00 2001 From: Erez Zukerman Date: Fri, 18 Dec 2015 16:03:47 +0200 Subject: Updates readme --- keyboard/ergodox_ez/README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) (limited to 'keyboard/ergodox_ez/README.md') diff --git a/keyboard/ergodox_ez/README.md b/keyboard/ergodox_ez/README.md index 5280698a62..cf40f79b23 100644 --- a/keyboard/ergodox_ez/README.md +++ b/keyboard/ergodox_ez/README.md @@ -1,6 +1,28 @@ -# Some tips on navigating the Quantum codebase +# Getting started -## These are the keycodes you're looking for +There are two main ways you could customize the ErgoDox EZ. + +## The Easy Way: Use an existing firmware file and just flash it + +1. Download and install the [Teensy Loader](https://www.pjrc.com/teensy/loader.html) +2. Find a firmware file you like. You can find a few if these in the keymaps subdirectory right here. The file you need ends with .hex, and you can look at its .c counterpart (or its PNG image) to see what you'll be getting. You can also use the [Massdrop configurator](https://keyboard-configurator.massdrop.com/ext/ergodox) to create a firmware Hex file you like. +3. Download the firmware file +4. Connect the keyboard, press its Reset button (gently insert a paperclip into the hole in the top-right corner) and flash it using the Teensy loader you installed on step 1 and the firmware you downloaded. + +## More technical: create your own totally custom firmware by editing the source files. + +This requires a little bit of familiarity with coding. + +1. Go to https://github.com/jackhumbert/qmk_firmware and read the Readme at the base of this repository, top to bottom. Then come back here :) +2. Clone the repository (download it) +3. Set up a build environment as per https://www.pjrc.com/teensy/gcc.html +4. Customize the firmware to your liking and compile it +5. Flash it using the [Teensy loader](https://www.pjrc.com/teensy/loader.html) as described in step 4 above. +6. Submit your work as a pull request to this repository, so others can also use it. :) + +Good luck! :) + +## Finding the keycodes you need Let's say you want a certain key in your layout to send a colon; to figure out what keycode to use to make it do that, you're going to need `quantum/keymap_common.h`. -- cgit v1.2.3 From 11f07249513825677fa6b386f74ee6b368ea3e57 Mon Sep 17 00:00:00 2001 From: Erez Zukerman Date: Sat, 19 Dec 2015 19:00:59 +0200 Subject: Further clarifies README --- keyboard/ergodox_ez/README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'keyboard/ergodox_ez/README.md') diff --git a/keyboard/ergodox_ez/README.md b/keyboard/ergodox_ez/README.md index cf40f79b23..de6b8edf90 100644 --- a/keyboard/ergodox_ez/README.md +++ b/keyboard/ergodox_ez/README.md @@ -16,9 +16,11 @@ This requires a little bit of familiarity with coding. 1. Go to https://github.com/jackhumbert/qmk_firmware and read the Readme at the base of this repository, top to bottom. Then come back here :) 2. Clone the repository (download it) 3. Set up a build environment as per https://www.pjrc.com/teensy/gcc.html -4. Customize the firmware to your liking and compile it -5. Flash it using the [Teensy loader](https://www.pjrc.com/teensy/loader.html) as described in step 4 above. -6. Submit your work as a pull request to this repository, so others can also use it. :) +4. Copy keymaps/keymap_default.c into keymaps/your_keymap_name.c +5. Edit this file, changing keycodes to your liking (see "Finding the keycodes you need" below). Try to edit the comments as well, so the "text graphics" represent your layout correctly. +6. Compile your firmware by running `make clean` followed by `make KEYMAP=your_keymap_name`. This will result in a hex file. +6. Flash this hex file using the [Teensy loader](https://www.pjrc.com/teensy/loader.html) as described in step 4 in the "Easy Way" above. +7. Submit your work as a pull request to this repository, so others can also use it. :) Good luck! :) -- cgit v1.2.3 From 58e237d2dc77450b5831701ad2a93de305c044ca Mon Sep 17 00:00:00 2001 From: Erez Zukerman Date: Wed, 23 Dec 2015 15:28:13 +0200 Subject: Updates readme --- keyboard/ergodox_ez/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'keyboard/ergodox_ez/README.md') diff --git a/keyboard/ergodox_ez/README.md b/keyboard/ergodox_ez/README.md index de6b8edf90..8085e5cd87 100644 --- a/keyboard/ergodox_ez/README.md +++ b/keyboard/ergodox_ez/README.md @@ -16,9 +16,9 @@ This requires a little bit of familiarity with coding. 1. Go to https://github.com/jackhumbert/qmk_firmware and read the Readme at the base of this repository, top to bottom. Then come back here :) 2. Clone the repository (download it) 3. Set up a build environment as per https://www.pjrc.com/teensy/gcc.html -4. Copy keymaps/keymap_default.c into keymaps/your_keymap_name.c +4. Copy `keymaps/keymap_default.c` into `keymaps/keymaps_your_name.c` (for example, `keymaps/keymap_german.c`) 5. Edit this file, changing keycodes to your liking (see "Finding the keycodes you need" below). Try to edit the comments as well, so the "text graphics" represent your layout correctly. -6. Compile your firmware by running `make clean` followed by `make KEYMAP=your_keymap_name`. This will result in a hex file. +6. Compile your firmware by running `make clean` followed by `make KEYMAP=your_name`. Note that you must omit the `keymap_` prefix for your filename in this command -- for example, `make KEYMAP=german`. This will result in a hex file, which will always be called `ergodox_ez.hex`, regardless of your keymap name. 6. Flash this hex file using the [Teensy loader](https://www.pjrc.com/teensy/loader.html) as described in step 4 in the "Easy Way" above. 7. Submit your work as a pull request to this repository, so others can also use it. :) -- cgit v1.2.3