diff options
author | Ryan <fauxpark@gmail.com> | 2021-07-31 06:57:40 +1000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-07-30 21:57:40 +0100 |
commit | b021c2f2c5890df5335d3dd163167c6fe6213e0d (patch) | |
tree | 3d1f645190a819f13d7789a11c55b0706e1d9853 /docs | |
parent | 770a52542592919e504603152f3a2950875150c9 (diff) | |
download | qmk_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.md | 4 | ||||
-rw-r--r-- | docs/es/hardware_avr.md | 38 | ||||
-rw-r--r-- | docs/hardware_avr.md | 38 | ||||
-rw-r--r-- | docs/ja/hardware_avr.md | 38 |
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 | ||
281 | This command creates a new keyboard based on available templates. | 281 | This command creates a new keyboard based on available templates. |
282 | 282 | ||
283 | This command will prompt for input to guide you though the generation process. | 283 | Any 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 | ``` |
288 | qmk new-keyboard | 288 | qmk 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 | ||
9 | QMK 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`: | 9 | QMK 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 |
13 | Generating a new QMK keyboard directory | 13 | Ψ Generating a new QMK keyboard directory |
14 | 14 | ||
15 | Keyboard Name: mycoolkb | 15 | Keyboard Name: mycoolkeeb |
16 | Keyboard Type [avr]: | 16 | Keyboard Type: |
17 | Your Name [John Smith]: | 17 | 1. avr |
18 | 18 | 2. ps2avrgb | |
19 | Copying base template files... done | 19 | Please enter your choice: [1] |
20 | Copying avr template files... done | 20 | Your Name: [John Smith] |
21 | Renaming keyboard files... done | 21 | Ψ Copying base template files... |
22 | Replacing %KEYBOARD% with mycoolkb... done | 22 | Ψ Copying avr template files... |
23 | Replacing %YOUR_NAME% with John Smith... done | 23 | Ψ Renaming keyboard.[ch] to mycoolkeeb.[ch]... |
24 | 24 | Ψ Replacing %YEAR% with 2021... | |
25 | Created a new keyboard called mycoolkb. | 25 | Ψ Replacing %KEYBOARD% with mycoolkeeb... |
26 | 26 | Ψ Replacing %YOUR_NAME% with John Smith... | |
27 | To start working on things, cd into keyboards/mycoolkb, | 27 | |
28 | or 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 | ||
31 | Esto 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. | 33 | Esto 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 | ||
9 | 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: | 9 | 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 `qmk new-keyboard`: |
10 | 10 | ||
11 | ``` | 11 | ``` |
12 | $ ./util/new_keyboard.sh | 12 | $ qmk new-keyboard |
13 | Generating a new QMK keyboard directory | 13 | Ψ Generating a new QMK keyboard directory |
14 | 14 | ||
15 | Keyboard Name: mycoolkb | 15 | Keyboard Name: mycoolkeeb |
16 | Keyboard Type [avr]: | 16 | Keyboard Type: |
17 | Your Name [John Smith]: | 17 | 1. avr |
18 | 18 | 2. ps2avrgb | |
19 | Copying base template files... done | 19 | Please enter your choice: [1] |
20 | Copying avr template files... done | 20 | Your Name: [John Smith] |
21 | Renaming keyboard files... done | 21 | Ψ Copying base template files... |
22 | Replacing %KEYBOARD% with mycoolkb... done | 22 | Ψ Copying avr template files... |
23 | Replacing %YOUR_NAME% with John Smith... done | 23 | Ψ Renaming keyboard.[ch] to mycoolkeeb.[ch]... |
24 | 24 | Ψ Replacing %YEAR% with 2021... | |
25 | Created a new keyboard called mycoolkb. | 25 | Ψ Replacing %KEYBOARD% with mycoolkeeb... |
26 | 26 | Ψ Replacing %YOUR_NAME% with John Smith... | |
27 | To start working on things, cd into keyboards/mycoolkb, | 27 | |
28 | or 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 | ||
31 | 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. | 33 | 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. |
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 | ||
15 | QMK には AVR を使ったキーボードでの作業を簡略化するための機能が多数あります。大体のキーボードでは1行もコードを書く必要がありません。まずはじめに、`util/new_keyboard.sh` スクリプトを実行します。 | 15 | QMK には AVR を使ったキーボードでの作業を簡略化するための機能が多数あります。大体のキーボードでは1行もコードを書く必要がありません。まずはじめに、`qmk new-keyboard` を実行します。 |
16 | 16 | ||
17 | ``` | 17 | ``` |
18 | $ ./util/new_keyboard.sh | 18 | $ qmk new-keyboard |
19 | Generating a new QMK keyboard directory | 19 | Ψ Generating a new QMK keyboard directory |
20 | 20 | ||
21 | Keyboard Name: mycoolkb | 21 | Keyboard Name: mycoolkeeb |
22 | Keyboard Type [avr]: | 22 | Keyboard Type: |
23 | Your Name [John Smith]: | 23 | 1. avr |
24 | 24 | 2. ps2avrgb | |
25 | Copying base template files... done | 25 | Please enter your choice: [1] |
26 | Copying avr template files... done | 26 | Your Name: [John Smith] |
27 | Renaming keyboard files... done | 27 | Ψ Copying base template files... |
28 | Replacing %KEYBOARD% with mycoolkb... done | 28 | Ψ Copying avr template files... |
29 | Replacing %YOUR_NAME% with John Smith... done | 29 | Ψ Renaming keyboard.[ch] to mycoolkeeb.[ch]... |
30 | 30 | Ψ Replacing %YEAR% with 2021... | |
31 | Created a new keyboard called mycoolkb. | 31 | Ψ Replacing %KEYBOARD% with mycoolkeeb... |
32 | 32 | Ψ Replacing %YOUR_NAME% with John Smith... | |
33 | To start working on things, cd into keyboards/mycoolkb, | 33 | |
34 | or 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 | これにより、新しいキーボードをサポートするために必要なすべてのファイルが作成され、デフォルト値で設定が入力されます。あとはあなたのキーボード用にカスタマイズするだけです。 |