Add cli command to import keyboard|keymap|kbfirmware (#16668)
This commit is contained in:
@ -352,6 +352,73 @@ $ qmk via2json -kb ai03/polaris -o polaris_keymap.json polaris_via_backup.json
|
||||
Ψ Wrote keymap to /home/you/qmk_firmware/polaris_keymap.json
|
||||
```
|
||||
|
||||
## `qmk import-keyboard`
|
||||
|
||||
This command imports a data-driven `info.json` keyboard into the repo.
|
||||
|
||||
**Usage**:
|
||||
|
||||
```
|
||||
usage: qmk import-keyboard [-h] filename
|
||||
```
|
||||
|
||||
**Example:**
|
||||
|
||||
```
|
||||
$ qmk import-keyboard ~/Downloads/forever60.json
|
||||
Ψ Importing forever60.json.
|
||||
|
||||
Ψ Imported a new keyboard named forever60.
|
||||
Ψ To start working on things, `cd` into keyboards/forever60,
|
||||
Ψ or open the directory in your preferred text editor.
|
||||
Ψ And build with qmk compile -kb forever60 -km default.
|
||||
```
|
||||
|
||||
## `qmk import-keymap`
|
||||
|
||||
This command imports a data-driven `keymap.json` keymap into the repo.
|
||||
|
||||
**Usage**:
|
||||
|
||||
```
|
||||
usage: qmk import-keymap [-h] filename
|
||||
```
|
||||
|
||||
**Example:**
|
||||
|
||||
```
|
||||
qmk import-keymap ~/Downloads/asdf2.json
|
||||
Ψ Importing asdf2.json.
|
||||
|
||||
Ψ Imported a new keymap named asdf2.
|
||||
Ψ To start working on things, `cd` into keyboards/takashicompany/dogtag/keymaps/asdf2,
|
||||
Ψ or open the directory in your preferred text editor.
|
||||
Ψ And build with qmk compile -kb takashicompany/dogtag -km asdf2.
|
||||
```
|
||||
|
||||
## `qmk import-kbfirmware`
|
||||
|
||||
This command creates a new keyboard based on a [Keyboard Firmware Builder](https://kbfirmware.com/) export.
|
||||
|
||||
**Usage**:
|
||||
|
||||
```
|
||||
usage: qmk import-kbfirmware [-h] filename
|
||||
```
|
||||
|
||||
**Example:**
|
||||
|
||||
```
|
||||
$ qmk import-kbfirmware ~/Downloads/gh62.json
|
||||
Ψ Importing gh62.json.
|
||||
|
||||
⚠ Support here is basic - Consider using 'qmk new-keyboard' instead
|
||||
Ψ Imported a new keyboard named gh62.
|
||||
Ψ To start working on things, `cd` into keyboards/gh62,
|
||||
Ψ or open the directory in your preferred text editor.
|
||||
Ψ And build with qmk compile -kb gh62 -km default.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Developer Commands
|
||||
@ -527,3 +594,4 @@ This command converts a TTF font to an intermediate format for editing, before c
|
||||
## `qmk painter-convert-font-image`
|
||||
|
||||
This command converts an intermediate font image to the QFF File Format. See the [Quantum Painter](quantum_painter.md?id=quantum-painter-cli) documentation for more information on this command.
|
||||
|
||||
|
Reference in New Issue
Block a user