diff options
Diffstat (limited to 'doc/PCB_GUIDE.md')
| -rw-r--r-- | doc/PCB_GUIDE.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/PCB_GUIDE.md b/doc/PCB_GUIDE.md index 3fad41dfb..16de71114 100644 --- a/doc/PCB_GUIDE.md +++ b/doc/PCB_GUIDE.md | |||
| @@ -5,7 +5,7 @@ | |||
| 5 | ### Windows | 5 | ### Windows |
| 6 | 1. Install [MHV AVR Tools](https://infernoembedded.com/sites/default/files/project/MHV_AVR_Tools_20131101.exe). Disable smatch, but **be sure to leave the option to add the tools to the PATH checked**. | 6 | 1. Install [MHV AVR Tools](https://infernoembedded.com/sites/default/files/project/MHV_AVR_Tools_20131101.exe). Disable smatch, but **be sure to leave the option to add the tools to the PATH checked**. |
| 7 | 2. Install [MinGW](https://sourceforge.net/projects/mingw/files/Installer/mingw-get-setup.exe/download). During installation, uncheck the option to install a graphical user interface. **DO NOT change the default installation folder.** The scripts depend on the default location. | 7 | 2. Install [MinGW](https://sourceforge.net/projects/mingw/files/Installer/mingw-get-setup.exe/download). During installation, uncheck the option to install a graphical user interface. **DO NOT change the default installation folder.** The scripts depend on the default location. |
| 8 | 3. Clone this repository. [This link will download it as a zip file, which you'll need to extract.](https://github.com/jackhumbert/qmk_firmware/archive/master.zip) Open the extracted folder in Windows Explorer. | 8 | 3. Clone this repository. [This link will download it as a zip file, which you'll need to extract.](https://github.com/qmk/qmk_firmware/archive/master.zip) Open the extracted folder in Windows Explorer. |
| 9 | 4. Right-click on the 1-setup-path-win batch script, select "Run as administrator", and accept the User Account Control prompt. Press the spacebar to dismiss the success message in the command prompt that pops up. | 9 | 4. Right-click on the 1-setup-path-win batch script, select "Run as administrator", and accept the User Account Control prompt. Press the spacebar to dismiss the success message in the command prompt that pops up. |
| 10 | 5. Right-click on the 2-setup-environment-win batch script, select "Run as administrator", and accept the User Account Control prompt. This part may take a couple of minutes, and you'll need to approve a driver installation, but once it finishes, your environment is complete! | 10 | 5. Right-click on the 2-setup-environment-win batch script, select "Run as administrator", and accept the User Account Control prompt. This part may take a couple of minutes, and you'll need to approve a driver installation, but once it finishes, your environment is complete! |
| 11 | 11 | ||
| @@ -32,7 +32,7 @@ Note that, since it will be directly accessing USB hardware, the | |||
| 32 | `dfu-programmer` program needs to be run as root. | 32 | `dfu-programmer` program needs to be run as root. |
| 33 | 33 | ||
| 34 | ## Verify Your Installation | 34 | ## Verify Your Installation |
| 35 | 1. Clone the following repository: https://github.com/jackhumbert/qmk_firmware | 35 | 1. Clone the following repository: https://github.com/qmk/qmk_firmware |
| 36 | 2. Open a Terminal and `cd` into `qmk_firmware/keyboards/planck` | 36 | 2. Open a Terminal and `cd` into `qmk_firmware/keyboards/planck` |
| 37 | 3. Run `make`. This should output a lot of information about the build process. | 37 | 3. Run `make`. This should output a lot of information about the build process. |
| 38 | 38 | ||
| @@ -80,7 +80,7 @@ when trying to 'make dfu' on Windows you need to copy the dfu-programmer.exe to | |||
| 80 | 80 | ||
| 81 | ### Keymap | 81 | ### Keymap |
| 82 | 82 | ||
| 83 | Unlike the other keymaps, prefixing the keycodes with `KC_` is required. A full list of the keycodes is available [here](https://github.com/jackhumbert/qmk_firmware/blob/master/tmk_core/doc/keycode.txt). For the keycodes available only in the extended keymap, see this [header file](https://github.com/jackhumbert/qmk_firmware/blob/master/quantum/keymap_common.h). | 83 | Unlike the other keymaps, prefixing the keycodes with `KC_` is required. A full list of the keycodes is available [here](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/doc/keycode.txt). For the keycodes available only in the extended keymap, see this [header file](https://github.com/qmk/qmk_firmware/blob/master/quantum/keymap_common.h). |
| 84 | 84 | ||
| 85 | You can use modifiers with keycodes like this: | 85 | You can use modifiers with keycodes like this: |
| 86 | 86 | ||