aboutsummaryrefslogtreecommitdiffstats
path: root/keyboard/ergodox_ez/README.md
diff options
context:
space:
mode:
authorGravatar Seth Herr <seth.william.herr@gmail.com>2016-01-06 09:41:42 -0600
committerGravatar Seth Herr <seth.william.herr@gmail.com>2016-01-06 09:41:42 -0600
commit1d463d961f5f185cac5402ba2eb80fb3c9a56c8a (patch)
tree44fd6cef21570f426b39b7c23b78ff05c71a5c3d /keyboard/ergodox_ez/README.md
parent9f4716a4b1fdf5ddcda3fa43d6a52ee556cf1ea4 (diff)
downloadqmk_firmware-1d463d961f5f185cac5402ba2eb80fb3c9a56c8a.tar.gz
Fix homebrew references
Replaces #64
Diffstat (limited to 'keyboard/ergodox_ez/README.md')
-rw-r--r--keyboard/ergodox_ez/README.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/keyboard/ergodox_ez/README.md b/keyboard/ergodox_ez/README.md
index 27568323b..51f1e2aa5 100644
--- a/keyboard/ergodox_ez/README.md
+++ b/keyboard/ergodox_ez/README.md
@@ -15,7 +15,8 @@ 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
+3. Set up a build environment as per [pjrc.com/teensy/gcc.html](https://www.pjrc.com/teensy/gcc.html)
+ - Using a Mac and have homebrew? just run `brew tap osx-cross/avr && brew install avr-libc`
4. Copy `keymaps/keymap_default.c` into `keymaps/keymap_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_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.