aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hardware_avr.md
diff options
context:
space:
mode:
authorWilliam Chang <william@factual.com>2019-05-09 21:16:15 -0700
committerWilliam Chang <william@factual.com>2019-05-09 21:16:15 -0700
commit9ce186860e78d5afe350636cb7445e18c2577f33 (patch)
treeb7f5dded777a950e63c4dd967260744336bfaa6b /docs/hardware_avr.md
parent57a6ea11df685d84a1ea07953e88f224ce2b24f7 (diff)
parent4b2d3288d013b1a71ea25402224c4a8225a099e9 (diff)
downloadfirmware-9ce186860e78d5afe350636cb7445e18c2577f33.tar.gz
firmware-9ce186860e78d5afe350636cb7445e18c2577f33.tar.bz2
firmware-9ce186860e78d5afe350636cb7445e18c2577f33.zip
Merge branch 'qmk-master'
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_
## Adding Your AVR Keyboard to QMK
-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_project.sh` script:
-
-```bash
-$ util/new_project.sh my_awesome_keyboard
-######################################################
-# /keyboards/my_awesome_keyboard project created. To start
-# working on things, cd into keyboards/my_awesome_keyboard
-######################################################
+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:
+
+```
+$ ./util/new_keyboard.sh
+Generating a new QMK keyboard directory
+
+Keyboard Name: mycoolkb
+Keyboard Type [avr]:
+Your Name [John Smith]:
+
+Copying base template files... done
+Copying avr template files... done
+Renaming keyboard files... done
+Replacing %KEYBOARD% with mycoolkb... done
+Replacing %YOUR_NAME% with John Smith... done
+
+Created a new keyboard called mycoolkb.
+
+To start working on things, cd into keyboards/mycoolkb,
+or open the directory in your favourite text editor.
```
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.