aboutsummaryrefslogtreecommitdiff
path: root/docs
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
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')
-rw-r--r--docs/cli_commands.md4
-rw-r--r--docs/es/hardware_avr.md38
-rw-r--r--docs/hardware_avr.md38
-rw-r--r--docs/ja/hardware_avr.md38
4 files changed, 62 insertions, 56 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index 314e7448d..c7468eb5e 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -280,12 +280,12 @@ qmk list-keymaps -kb planck/ez
280 280
281This command creates a new keyboard based on available templates. 281This command creates a new keyboard based on available templates.
282 282
283This command will prompt for input to guide you though the generation process. 283Any arguments that are not provided will prompt for input. If `-u` is not passed and `user.name` is set in .gitconfig, it will be used as the default username in the prompt.
284 284
285**Usage**: 285**Usage**:
286 286
287``` 287```
288qmk new-keyboard 288qmk new-keyboard [-kb KEYBOARD] [-t {avr,ps2avrgb}] -u USERNAME
289``` 289```
290 290
291## `qmk new-keymap` 291## `qmk new-keymap`
diff --git a/docs/es/hardware_avr.md b/docs/es/hardware_avr.md
index f8c426381..ac6a71565 100644
--- a/docs/es/hardware_avr.md
+++ b/docs/es/hardware_avr.md
@@ -6,26 +6,28 @@ Si aún no lo has hecho, debes leer las [Pautas de teclados](hardware_keyboard_g
6 6
7## Añadir tu Teclado AVR a QMK 7## Añadir tu Teclado AVR a QMK
8 8
9QMK tiene varias características para simplificar el trabajo con teclados AVR. Para la mayoría de los teclados no tienes que escribir ni una sola línea de código. Para empezar, ejecuta el archivo `util/new_keyboard.sh`: 9QMK tiene varias características para simplificar el trabajo con teclados AVR. Para la mayoría de los teclados no tienes que escribir ni una sola línea de código. Para empezar, ejecuta `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
31Esto creará todos los archivos necesarios para tu nuevo teclado, y rellenará la configuración con valores predeterminados. Ahora sólo tienes que personalizarlo para tu teclado. 33Esto creará todos los archivos necesarios para tu nuevo teclado, y rellenará la configuración con valores predeterminados. Ahora sólo tienes que personalizarlo para tu teclado.
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.
diff --git a/docs/ja/hardware_avr.md b/docs/ja/hardware_avr.md
index 66be2f71c..cdc5f8cb8 100644
--- a/docs/ja/hardware_avr.md
+++ b/docs/ja/hardware_avr.md
@@ -12,26 +12,28 @@
12 12
13## AVR を使用したキーボードを QMK に追加する 13## AVR を使用したキーボードを QMK に追加する
14 14
15QMK には AVR を使ったキーボードでの作業を簡略化するための機能が多数あります。大体のキーボードでは1行もコードを書く必要がありません。まずはじめに、`util/new_keyboard.sh` スクリプトを実行します。 15QMK には AVR を使ったキーボードでの作業を簡略化するための機能が多数あります。大体のキーボードでは1行もコードを書く必要がありません。まずはじめに、`qmk new-keyboard` を実行します。
16 16
17``` 17```
18$ ./util/new_keyboard.sh 18$ qmk new-keyboard
19Generating a new QMK keyboard directory 19Ψ Generating a new QMK keyboard directory
20 20
21Keyboard Name: mycoolkb 21Keyboard Name: mycoolkeeb
22Keyboard Type [avr]: 22Keyboard Type:
23Your Name [John Smith]: 23 1. avr
24 24 2. ps2avrgb
25Copying base template files... done 25Please enter your choice: [1]
26Copying avr template files... done 26Your Name: [John Smith]
27Renaming keyboard files... done 27Ψ Copying base template files...
28Replacing %KEYBOARD% with mycoolkb... done 28Ψ Copying avr template files...
29Replacing %YOUR_NAME% with John Smith... done 29Ψ Renaming keyboard.[ch] to mycoolkeeb.[ch]...
30 30Ψ Replacing %YEAR% with 2021...
31Created a new keyboard called mycoolkb. 31Ψ Replacing %KEYBOARD% with mycoolkeeb...
32 32Ψ Replacing %YOUR_NAME% with John Smith...
33To start working on things, cd into keyboards/mycoolkb, 33
34or open the directory in your favourite text editor. 34Ψ Created a new keyboard called mycoolkeeb.
35Ψ To start working on things, `cd` into keyboards/mycoolkeeb,
36Ψ or open the directory in your preferred text editor.
35``` 37```
36 38
37これにより、新しいキーボードをサポートするために必要なすべてのファイルが作成され、デフォルト値で設定が入力されます。あとはあなたのキーボード用にカスタマイズするだけです。 39これにより、新しいキーボードをサポートするために必要なすべてのファイルが作成され、デフォルト値で設定が入力されます。あとはあなたのキーボード用にカスタマイズするだけです。