summaryrefslogtreecommitdiffstats
path: root/docs/hand_wire.md
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2017-08-07 05:57:57 +0200
committerJack Humbert <jack.humb@gmail.com>2017-08-16 21:47:20 +0200
commit9d1a08e38ac9937cff4e61abfd0acc26ad5fdf4a (patch)
tree352da3e60b219405be323306bcd67a6729107d61 /docs/hand_wire.md
parent9b879b1267cd5cbebf4d73595c7ca4ed52fe5ef4 (diff)
downloadqmk_firmware-9d1a08e38ac9937cff4e61abfd0acc26ad5fdf4a.tar.gz
qmk_firmware-9d1a08e38ac9937cff4e61abfd0acc26ad5fdf4a.tar.xz
Doc updates from going through every file
Diffstat (limited to 'docs/hand_wire.md')
-rw-r--r--docs/hand_wire.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/hand_wire.md b/docs/hand_wire.md
index 9f6309542..263cd5994 100644
--- a/docs/hand_wire.md
+++ b/docs/hand_wire.md
@@ -298,13 +298,13 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
};
```
-Note that the layout of the keycodes is similar to the physical layout of our keyboard - this make it much easier to see what's going on. A lot of the keycodes should be fairly obvious, but for a full list of them, check out [tmk_code/doc/keycode.txt](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/doc/keycode.txt) - there are also a lot of aliases to condense your keymap file.
+Note that the layout of the keycodes is similar to the physical layout of our keyboard - this make it much easier to see what's going on. A lot of the keycodes should be fairly obvious, but for a full list of them, check out [Keycodes](keycodes.md) - there are also a lot of aliases to condense your keymap file.
It's also important to use the `KEYMAP` function we defined earlier - this is what allows the firmware to associate our intended readable keymap with the actual wiring.
## Compiling your firmware
-After you've written out your entire keymap, you're ready to get the firmware compiled and onto your Teensy. Before compiling, you'll need to get your [development environment set-up](build_guide.md) - you can skip the dfu-programmer instructions, but you'll need to download and install the [Teensy Loader](https://www.pjrc.com/teensy/loader.html) to get the firmware on your Teensy.
+After you've written out your entire keymap, you're ready to get the firmware compiled and onto your Teensy. Before compiling, you'll need to get your [development environment set-up](getting_started_build_tools.md) - you can skip the dfu-programmer instructions, but you'll need to download and install the [Teensy Loader](https://www.pjrc.com/teensy/loader.html) to get the firmware on your Teensy.
Once everything is installed, running `make` in the terminal should get you some output, and eventually a `<project_name>.hex` file in that folder. If you're having trouble with this step, see the end of the guide for the trouble-shooting section.
@@ -328,4 +328,4 @@ If you've done all of these things, keep in mind that sometimes you might have h
Now that you have a working board, it's time to get things in their permanent positions. I've often used liberal amounts of hot glue to secure and insulate things, so if that's your style, start spreading that stuff like butter. Otherwise, double-sided tape is always an elegant solution, and electrical tape is a distant second. Due to the nature of these builds, a lot of this part is up to you and how you planned (or didn't plan) things out.
-There are a lot of possibilities inside the firmware - check out the [readme](https://github.com/qmk/qmk_firmware/blob/master/readme.md) for a full feature list, and dive into the different project (Planck, Ergodox EZ, etc) to see how people use all of them. You can always stop by [the OLKB subreddit for help!](http://reddit.com/r/olkb)
+There are a lot of possibilities inside the firmware - explore [docs.qmk.fm](http://docs.qmk.fm) for a full feature list, and dive into the different project (Planck, Clueboard, Ergodox EZ, etc) to see how people use all of them. You can always stop by [the OLKB subreddit for help!](http://reddit.com/r/olkb)