aboutsummaryrefslogtreecommitdiff
path: root/docs/hardware_avr.md
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2021-07-31 06:57:40 +1000
committerGitHub <noreply@github.com>2021-07-30 21:57:40 +0100
commitb021c2f2c5890df5335d3dd163167c6fe6213e0d (patch)
tree3d1f645190a819f13d7789a11c55b0706e1d9853 /docs/hardware_avr.md
parent770a52542592919e504603152f3a2950875150c9 (diff)
downloadqmk_firmware-b021c2f2c5890df5335d3dd163167c6fe6213e0d.tar.gz
qmk_firmware-b021c2f2c5890df5335d3dd163167c6fe6213e0d.zip
Port new_keyboard.sh to CLI (#13706)
Co-authored-by: Erovia <Erovia@users.noreply.github.com>
Diffstat (limited to 'docs/hardware_avr.md')
-rw-r--r--docs/hardware_avr.md38
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
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: 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 `qmk new-keyboard`:
10 10
11``` 11```
12$ ./util/new_keyboard.sh 12$ qmk new-keyboard
13Generating a new QMK keyboard directory 13Ψ Generating a new QMK keyboard directory
14 14
15Keyboard Name: mycoolkb 15Keyboard Name: mycoolkeeb
16Keyboard Type [avr]: 16Keyboard Type:
17Your Name [John Smith]: 17 1. avr
18 18 2. ps2avrgb
19Copying base template files... done 19Please enter your choice: [1]
20Copying avr template files... done 20Your Name: [John Smith]
21Renaming keyboard files... done 21Ψ Copying base template files...
22Replacing %KEYBOARD% with mycoolkb... done 22Ψ Copying avr template files...
23Replacing %YOUR_NAME% with John Smith... done 23Ψ Renaming keyboard.[ch] to mycoolkeeb.[ch]...
24 24Ψ Replacing %YEAR% with 2021...
25Created a new keyboard called mycoolkb. 25Ψ Replacing %KEYBOARD% with mycoolkeeb...
26 26Ψ Replacing %YOUR_NAME% with John Smith...
27To start working on things, cd into keyboards/mycoolkb, 27
28or 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
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. 33This 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.