mirror of
https://github.com/qmk/qmk_firmware.git
synced 2026-10-01 06:19:16 +02:00
Deploying to gh-pages from @ qmk/qmk_firmware@0a3f7e4869 🚀
This commit is contained in:
@@ -90,6 +90,8 @@ This command is similar to `qmk compile`, but can also target a bootloader. The
|
||||
|
||||
This command is directory aware. It will automatically fill in KEYBOARD and/or KEYMAP if you are in a keyboard or keymap directory.
|
||||
|
||||
This command can also flash binary firmware files (hex or bin) such as the ones produced by [Configurator](https://config.qmk.fm).
|
||||
|
||||
**Usage for Configurator Exports**:
|
||||
|
||||
```
|
||||
@@ -102,6 +104,21 @@ qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] <configurat
|
||||
qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>]
|
||||
```
|
||||
|
||||
**Usage for pre-compiled firmwares**:
|
||||
|
||||
**Note**: The microcontroller needs to be specified (`-m` argument) for keyboards with the following bootloaders:
|
||||
* HalfKay
|
||||
* QMK HID
|
||||
* USBaspLoader
|
||||
|
||||
ISP flashing is also supported with the following flashers and require the microcontroller to be specified:
|
||||
* USBasp
|
||||
* USBtinyISP
|
||||
|
||||
```
|
||||
qmk flash [-m <microcontroller>] <compiledFirmware.[bin|hex]>
|
||||
```
|
||||
|
||||
**Listing the Bootloaders**
|
||||
|
||||
```
|
||||
@@ -352,6 +369,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 +611,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