diff options
| author | William Chang <william@factual.com> | 2019-05-09 21:16:15 -0700 |
|---|---|---|
| committer | William Chang <william@factual.com> | 2019-05-09 21:16:15 -0700 |
| commit | 9ce186860e78d5afe350636cb7445e18c2577f33 (patch) | |
| tree | b7f5dded777a950e63c4dd967260744336bfaa6b /docs/porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md | |
| parent | 57a6ea11df685d84a1ea07953e88f224ce2b24f7 (diff) | |
| parent | 4b2d3288d013b1a71ea25402224c4a8225a099e9 (diff) | |
| download | firmware-9ce186860e78d5afe350636cb7445e18c2577f33.tar.gz firmware-9ce186860e78d5afe350636cb7445e18c2577f33.tar.bz2 firmware-9ce186860e78d5afe350636cb7445e18c2577f33.zip | |
Merge branch 'qmk-master'
Diffstat (limited to 'docs/porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md')
| -rw-r--r-- | docs/porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md | 24 |
1 files changed, 17 insertions, 7 deletions
diff --git a/docs/porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md b/docs/porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md index d8e084f46..979eafbc8 100644 --- a/docs/porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md +++ b/docs/porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md @@ -1,14 +1,24 @@ -Setting up your ARM based PCB is a little more involved than an Atmel MCU, but is easy enough. Start by using `util/new_project.sh <keyboard>` to create a new project: +Setting up your ARM based PCB is a little more involved than an Atmel MCU, but is easy enough. Start by running `util/new_keyboard.sh`: ``` -$ util/new_project.sh simontester -###################################################### -# /keyboards/simontester project created. To start -# working on things, cd into keyboards/simontester -###################################################### -``` +$ ./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. +``` # END OF NEW ARM DOC, OLD ATMEL DOC FOLLOWS |