aboutsummaryrefslogtreecommitdiff
path: root/docs/hardware_avr.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/hardware_avr.md')
-rw-r--r--docs/hardware_avr.md28
1 files changed, 20 insertions, 8 deletions
diff --git a/docs/hardware_avr.md b/docs/hardware_avr.md
index acf7088a3..7c28ab6db 100644
--- a/docs/hardware_avr.md
+++ b/docs/hardware_avr.md
@@ -6,14 +6,26 @@ 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
9QMK 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_project.sh` script: 9QMK 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:
10 10
11```bash 11```
12$ util/new_project.sh my_awesome_keyboard 12$ ./util/new_keyboard.sh
13###################################################### 13Generating a new QMK keyboard directory
14# /keyboards/my_awesome_keyboard project created. To start 14
15# working on things, cd into keyboards/my_awesome_keyboard 15Keyboard Name: mycoolkb
16###################################################### 16Keyboard Type [avr]:
17Your Name [John Smith]:
18
19Copying base template files... done
20Copying avr template files... done
21Renaming keyboard files... done
22Replacing %KEYBOARD% with mycoolkb... done
23Replacing %YOUR_NAME% with John Smith... done
24
25Created a new keyboard called mycoolkb.
26
27To start working on things, cd into keyboards/mycoolkb,
28or open the directory in your favourite text editor.
17``` 29```
18 30
19This 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. 31This 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.