aboutsummaryrefslogtreecommitdiff
path: root/docs/hardware_avr.md
diff options
context:
space:
mode:
authorfauxpark <fauxpark@gmail.com>2019-04-28 09:42:16 +1000
committerMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-04-27 16:42:16 -0700
commit53c51f1d16b40fdd3e68a6afc5844917d3d58640 (patch)
treeb17a8b084e538b66a6ccb4893e9c7fa75217c519 /docs/hardware_avr.md
parentc3be0520c4c6d4799670ab3639a3de561b4c6c1d (diff)
downloadqmk_firmware-53c51f1d16b40fdd3e68a6afc5844917d3d58640.tar.gz
qmk_firmware-53c51f1d16b40fdd3e68a6afc5844917d3d58640.zip
A better new_project.sh (#5191)
* A better new_project.sh * Fix docstrings * Use single quotes for anything not shown to user * Missed this docstring * Simplify get_git_username() Thanks @vomindoraan * chmod +x * Add docstring for print_error() * Break up git username call into multiple lines * Use with statement here * Conform to PEP 8 even more * Turn it back into a shell script * chmod +x again * Update docs to reflect new keyboard generator usage * Tweak wording slightly * Trim trailing whitespace * Don't actually need to escape the newlines here * As I suspected, you can pass shift a number * Prepend ./ to match the other code block * Minor syntax tweaks * The username token has changed * Replace name in the readme too * Make some reasonable assumptions about the presence of Git
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.