summaryrefslogtreecommitdiff
path: root/docs/newbs_getting_started.md
diff options
context:
space:
mode:
authorNick Brassel <nick@tzarc.org>2024-05-30 12:00:41 +1000
committerGitHub <noreply@github.com>2024-05-30 12:00:41 +1000
commit6ef97172889ccd5db376b2a9f8825489e24fdac4 (patch)
tree334e3bf41c8554d4bee73a140822f95f60eb64e9 /docs/newbs_getting_started.md
parent395766657ff98a4b1fd0dcba5917557f8acbb9e4 (diff)
Vitepress conversion of docs. (#23795)0.25.2
Diffstat (limited to 'docs/newbs_getting_started.md')
-rw-r--r--docs/newbs_getting_started.md114
1 files changed, 75 insertions, 39 deletions
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md
index 68e37679b8..3a901ad7ad 100644
--- a/docs/newbs_getting_started.md
+++ b/docs/newbs_getting_started.md
@@ -6,20 +6,22 @@ Before you can build keymaps, you need to install some software and set up your
There are a few pieces of software you'll need to get started.
-* [Text editor](newbs_learn_more_resources.md#text-editor-resources)
+* [Text editor](newbs_learn_more_resources#text-editor-resources)
* You’ll need a program that can edit and save plain text files. The default editor that comes with many OS's does not save plain text files, so you'll need to make sure that whatever editor you chose does.
* [Toolbox (optional)](https://github.com/qmk/qmk_toolbox)
* A graphical program for Windows and macOS that allows you to both program and debug your custom keyboard
-?> If you haven't worked with the Linux/Unix command line before, there are a few basic concepts and commands you should learn. [These resources](newbs_learn_more_resources.md#command-line-resources) will teach you enough to be able to work with QMK.
+::: tip
+If you haven't worked with the Linux/Unix command line before, there are a few basic concepts and commands you should learn. [These resources](newbs_learn_more_resources#command-line-resources) will teach you enough to be able to work with QMK.
+:::
-## 2. Prepare Your Build Environment :id=set-up-your-environment
+## 2. Prepare Your Build Environment {#set-up-your-environment}
We've tried to make QMK as easy to set up as possible. You only have to prepare your Linux or Unix environment, then let QMK install the rest.
-<!-- tabs:start -->
+:::::tabs
-### ** Windows **
+==== Windows
QMK maintains a Bundle of MSYS2, the CLI and all necessary dependencies. It also provides a handy `QMK MSYS` terminal shortcut to boot you directly into the correct environment.
@@ -27,10 +29,11 @@ QMK maintains a Bundle of MSYS2, the CLI and all necessary dependencies. It also
You will need to install [QMK MSYS](https://msys.qmk.fm/). The latest release is available [here](https://github.com/qmk/qmk_distro_msys/releases/latest).
-<details>
- <summary>Advanced Users</summary>
+:::: details Advanced Users
-!> <b style="font-size:150%">This process is not recommended for new users.</b>
+::: danger
+<b style="font-size:150%">This process is not recommended for new users.</b>
+:::
If you'd like to manually install MSYS2, the following sections will walk you through the process.
@@ -38,17 +41,21 @@ If you'd like to manually install MSYS2, the following sections will walk you th
You will need to install [MSYS2](https://www.msys2.org). Once installed, close any open MSYS terminals (purple icon) and open a new MinGW 64-bit terminal (blue icon) from the Start Menu.
-!> **NOTE:** The MinGW 64-bit terminal is *not* the same as the MSYS terminal that opens when installation is completed. Your prompt should say "MINGW64" in purple text, rather than "MSYS". See [this page](https://www.msys2.org/wiki/MSYS2-introduction/#subsystems) for more information on the differences.
+::: warning
+**NOTE:** The MinGW 64-bit terminal is *not* the same as the MSYS terminal that opens when installation is completed. Your prompt should say "MINGW64" in purple text, rather than "MSYS". See [this page](https://www.msys2.org/wiki/MSYS2-introduction/#subsystems) for more information on the differences.
+:::
#### Installation
Install the QMK CLI by running:
- pacman --needed --noconfirm --disable-download-timeout -S git mingw-w64-x86_64-python-qmk
+```sh
+pacman --needed --noconfirm --disable-download-timeout -S git mingw-w64-x86_64-python-qmk
+```
-</details>
+::::
-### ** macOS **
+==== macOS
QMK maintains a Homebrew tap and formula which will automatically install the CLI and all necessary dependencies.
@@ -56,17 +63,23 @@ QMK maintains a Homebrew tap and formula which will automatically install the CL
You will need to install Homebrew. Follow the instructions on https://brew.sh.
-?> If you are using an Apple Silicon machine, the installation process will take significantly longer because GitHub actions do not have native runners to build binary packages for the ARM and AVR toolchains.
+::: tip
+If you are using an Apple Silicon machine, the installation process will take significantly longer because GitHub actions do not have native runners to build binary packages for the ARM and AVR toolchains.
+:::
#### Installation
Install the QMK CLI by running:
- brew install qmk/qmk/qmk
-
-### ** Linux/WSL **
+```sh
+brew install qmk/qmk/qmk
+```
+
+==== Linux/WSL
-?> **Note for WSL users**: By default, the installation process will clone the QMK repository into your WSL home directory, but if you have cloned manually, ensure that it is located inside the WSL instance instead of the Windows filesystem (ie. not in `/mnt`), as accessing it is currently [extremely slow](https://github.com/microsoft/WSL/issues/4197).
+::: tip
+**Note for WSL users**: By default, the installation process will clone the QMK repository into your WSL home directory, but if you have cloned manually, ensure that it is located inside the WSL instance instead of the Windows filesystem (ie. not in `/mnt`), as accessing it is currently [extremely slow](https://github.com/microsoft/WSL/issues/4197).
+:::
#### Prerequisites
@@ -84,7 +97,9 @@ You will need to install Git and Python. It's very likely that you already have
Install the QMK CLI by running:
- python3 -m pip install --user qmk
+```sh
+python3 -m pip install --user qmk
+```
#### Community Packages
@@ -92,71 +107,90 @@ These packages are maintained by community members, so may not be up to date or
On Arch-based distros you can install the CLI from the official repositories (NOTE: at the time of writing this package marks some dependencies as optional that should not be):
- sudo pacman -S qmk
+```sh
+sudo pacman -S qmk
+```
You can also try the `qmk-git` package from AUR:
- yay -S qmk-git
+```sh
+yay -S qmk-git
+```
-### ** FreeBSD **
+==== FreeBSD
#### Installation
Install the FreeBSD package for QMK CLI by running:
- pkg install -g "py*-qmk"
+```sh
+pkg install -g "py*-qmk"
+```
NOTE: remember to follow the instructions printed at the end of installation (use `pkg info -Dg "py*-qmk"` to show them again).
-<!-- tabs:end -->
+:::::
-## 3. Run QMK Setup :id=set-up-qmk
+## 3. Run QMK Setup {#set-up-qmk}
-<!-- tabs:start -->
+::::tabs
-### ** Windows **
+=== Windows
Open QMK MSYS and run the following command:
- qmk setup
+```sh
+qmk setup
+```
In most situations you will want to answer `y` to all of the prompts.
-### ** macOS **
+=== macOS
Open Terminal and run the following command:
- qmk setup
+```sh
+qmk setup
+```
In most situations you will want to answer `y` to all of the prompts.
-### ** Linux/WSL **
+=== Linux/WSL
Open your preferred terminal app and run the following command:
- qmk setup
+```sh
+qmk setup
+```
In most situations you will want to answer `y` to all of the prompts.
-?>**Note on Debian, Ubuntu and their derivatives**:
+::: info Note on Debian, Ubuntu and their derivatives:
It's possible, that you will get an error saying something like: `bash: qmk: command not found`.
This is due to a [bug](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=839155) Debian introduced with their Bash 4.4 release, which removed `$HOME/.local/bin` from the PATH. This bug was later fixed on Debian and Ubuntu.
Sadly, Ubuntu reintroduced this bug and is [yet to fix it](https://bugs.launchpad.net/ubuntu/+source/bash/+bug/1588562).
Luckily, the fix is easy. Run this as your user: `echo 'PATH="$HOME/.local/bin:$PATH"' >> $HOME/.bashrc && source $HOME/.bashrc`
+:::
-### ** FreeBSD **
+=== FreeBSD
Open your preferred terminal app and run the following command:
- qmk setup
+```sh
+qmk setup
+```
In most situations you will want to answer `y` to all of the prompts.
-<!-- tabs:end -->
+::::
-?> The qmk home folder can be specified at setup with `qmk setup -H <path>`, and modified afterwards using the [cli configuration](cli_configuration.md?id=single-key-example) and the variable `user.qmk_home`. For all available options run `qmk setup --help`.
+::: tip
+The qmk home folder can be specified at setup with `qmk setup -H <path>`, and modified afterwards using the [cli configuration](cli_configuration#single-key-example) and the variable `user.qmk_home`. For all available options run `qmk setup --help`.
+:::
-?> If you already know how to use GitHub, [we recommend that you follow these instructions](getting_started_github.md) and use `qmk setup <github_username>/qmk_firmware` to clone your personal fork. If you don't know what that means you can safely ignore this message.
+::: tip
+If you already know how to use GitHub, [we recommend that you follow these instructions](getting_started_github) and use `qmk setup <github_username>/qmk_firmware` to clone your personal fork. If you don't know what that means you can safely ignore this message.
+:::
## 4. Test Your Build Environment
@@ -168,7 +202,9 @@ For example, to build a firmware for a Clueboard 66% you would use:
qmk compile -kb clueboard/66/rev3 -km default
-?> The keyboard option is the path relative to the keyboard directory, the above example would be found in `qmk_firmware/keyboards/clueboard/66/rev3`. If you're unsure you can view a full list of supported keyboards with `qmk list-keyboards`.
+::: tip
+The keyboard option is the path relative to the keyboard directory, the above example would be found in `qmk_firmware/keyboards/clueboard/66/rev3`. If you're unsure you can view a full list of supported keyboards with `qmk list-keyboards`.
+:::
When it is done you should have a lot of output that ends similar to this:
@@ -182,4 +218,4 @@ Checking file size of clueboard_66_rev3_default.hex
# Creating Your Keymap
-You are now ready to create your own personal keymap! Move on to [Building Your First Firmware](newbs_building_firmware.md) for that.
+You are now ready to create your own personal keymap! Move on to [Building Your First Firmware](newbs_building_firmware) for that.