add remaining, convert tabs
This commit is contained in:
Jack Humbert
@ -8,16 +8,16 @@ QMK (*Quantum Mechanical Keyboard*) is an open source community centered around
|
||||
|
||||
<div class="flex-container">
|
||||
|
||||
:::caution
|
||||
:::tip Basic
|
||||
|
||||
**Basic** [QMK Configurator](newbs_building_firmware_configurator.md) <br />
|
||||
[QMK Configurator](newbs_building_firmware_configurator.md) <br />
|
||||
User friendly graphical interfaces, no programming knowledge required.
|
||||
|
||||
:::
|
||||
|
||||
:::caution
|
||||
:::caution Advanced
|
||||
|
||||
**Advanced** [Use The Source](newbs.md) <br />
|
||||
[Use The Source](newbs.md) <br />
|
||||
More powerful, but harder to use.
|
||||
|
||||
:::
|
||||
|
||||
@ -1,3 +1,6 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Building QMK with GitHub Userspace
|
||||
|
||||
This is an intermediate QMK tutorial to setup an out-of-tree build environment with a personal GitHub repository. It avoids using a fork of the QMK firmware to store and build your keymap within its source tree. Keymap files will instead be stored in your own personal GitHub repository, in [Userspace](https://docs.qmk.fm/#/feature_userspace) format, and built with an action workflow. Unlike the [default tutorial](https://docs.qmk.fm/#/newbs), this guide requires some familiarity with using Git.
|
||||
@ -34,17 +37,19 @@ If you are familiar with using [github.dev](https://docs.github.com/en/codespace
|
||||
|
||||
A working Git client is required for your local operating system to commit and push changes to GitHub.
|
||||
|
||||
<!-- tabs:start -->
|
||||
<Tabs groupId="operating-systems">
|
||||
|
||||
### ** Windows **
|
||||
<TabItem value="windows" label="Windows" default>
|
||||
|
||||
QMK maintains a bundle of MSYS2, the CLI and all necessary dependencies including Git. Install [QMK MSYS](https://msys.qmk.fm/) with the latest release [here](https://github.com/qmk/qmk_distro_msys/releases/latest). Git will be part of the bundle.
|
||||
|
||||
### ** macOS **
|
||||
</TabItem>
|
||||
<TabItem value="macOS" label="macOS">
|
||||
|
||||
Install Homebrew following the instructions on https://brew.sh. Git will be part of the bundle.
|
||||
|
||||
### ** Linux/WSL **
|
||||
</TabItem>
|
||||
<TabItem value="linux" label="Linux/WSL">
|
||||
|
||||
It's very likely that you already have Git installed. If not, use one of the following commands:
|
||||
|
||||
@ -56,7 +61,8 @@ It's very likely that you already have Git installed. If not, use one of the fol
|
||||
* Sabayon: `sudo equo install dev-vcs/git`
|
||||
* Gentoo: `sudo emerge dev-vcs/git`
|
||||
|
||||
<!-- tabs:end -->
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### 2. GitHub authentication
|
||||
|
||||
|
||||
@ -1,3 +1,6 @@
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Flashing Your Keyboard
|
||||
|
||||
Now that you've built a custom firmware file you'll want to flash your keyboard.
|
||||
@ -37,21 +40,25 @@ Begin by opening the QMK Toolbox application. You'll want to locate the firmware
|
||||
|
||||
If you are on Windows or macOS, there are commands you can use to easily open the current folder in Explorer or Finder.
|
||||
|
||||
<!-- tabs:start -->
|
||||
<Tabs groupId="operating-systems">
|
||||
|
||||
#### ** Windows **
|
||||
<TabItem value="windows" label="Windows" default>
|
||||
|
||||
```
|
||||
start .
|
||||
```
|
||||
|
||||
#### ** macOS **
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="macOS" label="macOS">
|
||||
|
||||
```
|
||||
open .
|
||||
```
|
||||
|
||||
<!-- tabs:end -->
|
||||
</TabItem>
|
||||
|
||||
</Tabs>
|
||||
|
||||
The firmware file always follows this naming format:
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,4 +1,4 @@
|
||||
# 'serial' Driver
|
||||
# Serial Driver
|
||||
|
||||
The serial driver powers the [Split Keyboard](feature_split_keyboard.md) feature. Several implementations are available, depending on the platform of your split keyboard. Note that none of the drivers support split keyboards with more than two halves.
|
||||
|
||||
|
||||
103
docs/sidebars.js
103
docs/sidebars.js
@ -98,9 +98,7 @@ const sidebars = {
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Using QMK",
|
||||
items: [
|
||||
"Using QMK": [
|
||||
{
|
||||
Guides: [
|
||||
"custom_quantum_functions",
|
||||
@ -220,6 +218,105 @@ const sidebars = {
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
"Developing QMK": [
|
||||
"pr_checklist",
|
||||
{
|
||||
type: "category",
|
||||
label: "Breaking Changes",
|
||||
link: {
|
||||
type: "doc",
|
||||
id: "breaking_changes",
|
||||
},
|
||||
items: [
|
||||
"breaking_changes_instructions",
|
||||
"ChangeLog/20230226",
|
||||
"breaking_changes_history",
|
||||
],
|
||||
},
|
||||
{
|
||||
"C Development": [
|
||||
"arm_debugging",
|
||||
"coding_conventions_c",
|
||||
"compatible_microcontrollers",
|
||||
"hardware_drivers",
|
||||
"adc_driver",
|
||||
"audio_driver",
|
||||
"i2c_driver",
|
||||
"spi_driver",
|
||||
"ws2812_driver",
|
||||
"eeprom_driver",
|
||||
"flash_driver",
|
||||
"serial_driver",
|
||||
"uart_driver",
|
||||
"gpio_control",
|
||||
"hardware_keyboard_guidelines",
|
||||
],
|
||||
},
|
||||
{
|
||||
"Python Development": [
|
||||
"coding_conventions_python",
|
||||
"cli_development",
|
||||
],
|
||||
},
|
||||
{
|
||||
"Configurator Development": [
|
||||
{
|
||||
"QMK API": [
|
||||
"api_development_environment",
|
||||
"api_development_overview",
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
"Hardware Platform Development": [
|
||||
{
|
||||
"Arm/ChibiOS": [
|
||||
"platformdev_selecting_arm_mcu",
|
||||
"platformdev_chibios_earlyinit",
|
||||
"platformdev_rp2040",
|
||||
"platformdev_proton_c",
|
||||
"platformdev_blackpill_f4x1",
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
"QMK Reference": [
|
||||
"contributing",
|
||||
"translating",
|
||||
"config_options",
|
||||
"data_driven_config",
|
||||
"getting_started_make_guide",
|
||||
"documentation_best_practices",
|
||||
"documentation_templates",
|
||||
"feature_layouts",
|
||||
"unit_testing",
|
||||
"ref_functions",
|
||||
"reference_info_json",
|
||||
],
|
||||
},
|
||||
{
|
||||
"For a Deeper Understanding": [
|
||||
"how_keyboards_work",
|
||||
"how_a_matrix_works",
|
||||
"understanding_qmk",
|
||||
],
|
||||
},
|
||||
{
|
||||
"QMK Internals": [
|
||||
"internals/defines",
|
||||
"internals/input_callback_reg",
|
||||
"internals/midi_device",
|
||||
"internals/midi_device_setup_process",
|
||||
"internals/midi_util",
|
||||
"internals/send_functions",
|
||||
"internals/sysex_tools",
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
|
||||
Reference in New Issue
Block a user