diff options
Diffstat (limited to 'docs/hardware_avr.md')
| -rw-r--r-- | docs/hardware_avr.md | 38 |
1 files changed, 20 insertions, 18 deletions
diff --git a/docs/hardware_avr.md b/docs/hardware_avr.md index eb536ca96..3d58cdc05 100644 --- a/docs/hardware_avr.md +++ b/docs/hardware_avr.md | |||
| @@ -6,26 +6,28 @@ If you have not yet you should read the [Keyboard Guidelines](hardware_keyboard_ | |||
| 6 | 6 | ||
| 7 | ## Adding Your AVR Keyboard to QMK | 7 | ## Adding Your AVR Keyboard to QMK |
| 8 | 8 | ||
| 9 | QMK has a number of features to simplify working with AVR keyboards. For most keyboards you don't have to write a single line of code. To get started, run the `util/new_keyboard.sh` script: | 9 | QMK has a number of features to simplify working with AVR keyboards. For most keyboards you don't have to write a single line of code. To get started, run `qmk new-keyboard`: |
| 10 | 10 | ||
| 11 | ``` | 11 | ``` |
| 12 | $ ./util/new_keyboard.sh | 12 | $ qmk new-keyboard |
| 13 | Generating a new QMK keyboard directory | 13 | Ψ Generating a new QMK keyboard directory |
| 14 | 14 | ||
| 15 | Keyboard Name: mycoolkb | 15 | Keyboard Name: mycoolkeeb |
| 16 | Keyboard Type [avr]: | 16 | Keyboard Type: |
| 17 | Your Name [John Smith]: | 17 | 1. avr |
| 18 | 18 | 2. ps2avrgb | |
| 19 | Copying base template files... done | 19 | Please enter your choice: [1] |
| 20 | Copying avr template files... done | 20 | Your Name: [John Smith] |
| 21 | Renaming keyboard files... done | 21 | Ψ Copying base template files... |
| 22 | Replacing %KEYBOARD% with mycoolkb... done | 22 | Ψ Copying avr template files... |
| 23 | Replacing %YOUR_NAME% with John Smith... done | 23 | Ψ Renaming keyboard.[ch] to mycoolkeeb.[ch]... |
| 24 | 24 | Ψ Replacing %YEAR% with 2021... | |
| 25 | Created a new keyboard called mycoolkb. | 25 | Ψ Replacing %KEYBOARD% with mycoolkeeb... |
| 26 | 26 | Ψ Replacing %YOUR_NAME% with John Smith... | |
| 27 | To start working on things, cd into keyboards/mycoolkb, | 27 | |
| 28 | or open the directory in your favourite text editor. | 28 | Ψ Created a new keyboard called mycoolkeeb. |
| 29 | Ψ To start working on things, `cd` into keyboards/mycoolkeeb, | ||
| 30 | Ψ or open the directory in your preferred text editor. | ||
| 29 | ``` | 31 | ``` |
| 30 | 32 | ||
| 31 | This will create all the files needed to support your new keyboard, and populate the settings with default values. Now you just need to customize it for your keyboard. | 33 | This will create all the files needed to support your new keyboard, and populate the settings with default values. Now you just need to customize it for your keyboard. |
