aboutsummaryrefslogtreecommitdiffstats
path: root/docs/newbs_getting_started.md
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2020-02-20 15:50:50 -0800
committerskullydazed <skullydazed@users.noreply.github.com>2020-03-05 16:00:10 -0800
commita701c15d872ad171592335e61e91d7234dbec54a (patch)
treeef06fabdf0c0cd5d7457b63c48264700ac7fc67c /docs/newbs_getting_started.md
parent1b7fa46f8e0616450bed8bff71bc1cffbca2eac8 (diff)
downloadfirmware-a701c15d872ad171592335e61e91d7234dbec54a.tar.gz
firmware-a701c15d872ad171592335e61e91d7234dbec54a.tar.bz2
firmware-a701c15d872ad171592335e61e91d7234dbec54a.zip
Rework the newbs guide around the qmk cli
Diffstat (limited to 'docs/newbs_getting_started.md')
-rw-r--r--docs/newbs_getting_started.md63
1 files changed, 36 insertions, 27 deletions
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md
index 1c7206cf5..7ea4c62e2 100644
--- a/docs/newbs_getting_started.md
+++ b/docs/newbs_getting_started.md
@@ -1,15 +1,14 @@
# Getting Started
-Your computer keyboard has a processor inside of it, not unlike the one inside your computer. This processor runs software that is responsible for detecting button presses and sending reports about the state of the keyboard when buttons are pressed or released. QMK fills the role of that software, detecting button presses and passing that information on to the host computer. When you build your custom keymap, you are creating the equivalent of an executable program for your keyboard.
+Your computer keyboard has a processor inside of it, similar to the one inside your computer. This processor runs software that is responsible for detecting button presses and informing the computer when keys are pressed. QMK fills the role of that software, detecting button presses and passing that information on to the host computer. When you build your custom keymap, you are creating an executable program for your keyboard.
QMK tries to put a lot of power into your hands by making easy things easy, and hard things possible. You don't have to know how to program to create powerful keymaps — you only have to follow a few simple syntax rules.
# Prerequisites
-Before you can build keymaps, you need to install some software and set up your build environment. This only has to be done once no matter how many keyboards you plan to compile firmware for.
-
-If you would prefer a more graphical user interface approach, please consider using the online [QMK Configurator](https://config.qmk.fm). Please refer to [Building Your First Firmware using the online GUI](newbs_building_firmware_configurator.md).
+Before you can build keymaps, you need to install some software and set up your build environment. This only has to be done once no matter how many keyboards you plan to compile firmware for.
+If you would prefer a more graphical user interface approach, please consider using the online [QMK Configurator](newbs_building_firmware_configurator.md).
## Download Software
@@ -40,52 +39,50 @@ We've tried to make QMK as easy to set up as possible. You only have to prepare
### Windows
-You will need to install MSYS2 and Git.
+You will need to install MSYS2, Git, and the QMK CLI.
* Follow the installation instructions on the [MSYS2 homepage](http://www.msys2.org).
* Close any open MSYS2 terminals and open a new MSYS2 MinGW 64-bit terminal.
-* Install Git by running this command: `pacman -S git`.
-### macOS
+After opening a new MSYS2 MinGW 64-bit terminal run these commands:
-You will need to install Homebrew. Follow the instructions on the [Homebrew homepage](https://brew.sh).
+ pacman -S git python3-pip
+ python3 -m pip install qmk
+ qmk setup
-After Homebrew is installed, continue with _Set Up QMK_. In that step you will run a script that will install other packages.
+### macOS
-### Linux
+You will need to install Homebrew. Follow the instructions on the [Homebrew homepage](https://brew.sh).
-You will need to install Git. It's very likely that you already have it, but if not, one of the following commands should install it:
+After Homebrew is installed run these commands:
-* Debian / Ubuntu / Devuan: `apt-get install git`
-* Fedora / Red Hat / CentOS: `yum install git`
-* Arch: `pacman -S git`
+ brew tap qmk/qmk
+ brew install qmk
+ qmk setup
-?> Docker is also an option on all platforms. [Click here for details.](getting_started_build_tools.md#docker)
+### Linux
-## Set Up QMK
+You will need to install Git and Python. It's very likely that you already have both, but if not, one of the following commands should install them:
-Once you have set up your Linux/Unix environment, you are ready to download QMK. We will do this by using Git to "clone" the QMK repository. Open a Terminal or MSYS2 MinGW window and leave it open for the remainder of this guide. Inside that window run these two commands:
+* Debian / Ubuntu / Devuan: `apt-get install git python3 && python3 -m pip install qmk`
+* Fedora / Red Hat / CentOS: `yum install git python3 && python3 -m pip install qmk`
+* Arch: `pacman -S qmk`
-```shell
-git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git
-cd qmk_firmware
-```
+After installing QMK you can set it up with this command:
-?> If you already know [how to use GitHub](getting_started_github.md), we recommend that you create and clone your own fork instead. If you don't know what that means, you can safely ignore this message.
+ qmk setup
-QMK comes with a script to help you set up the rest of what you'll need. You should run it now by typing in this command:
-
- util/qmk_install.sh
+?> If you already know [how to use GitHub](getting_started_github.md), we recommend that you create your own fork and use `qmk setup <github_username>` to clone your personal fork. If you don't know what that means you can safely ignore this message.
## Test Your Build Environment
Now that your QMK build environment is set up, you can build a firmware for your keyboard. Start by trying to build the keyboard's default keymap. You should be able to do that with a command in this format:
- make <keyboard>:default
+ qmk compile -kb <keyboard> -km default
For example, to build a firmware for a Clueboard 66% you would use:
- make clueboard/66/rev3:default
+ qmk compile -kb clueboard/66/rev3 -km default
When it is done you should have a lot of output that ends similar to this:
@@ -97,6 +94,18 @@ Checking file size of clueboard_66_rev3_default.hex
* The firmware size is fine - 26356/28672 (2316 bytes free)
```
+## Configure Your Build Environment
+
+You can configure your build environment to set the defaults and make working with QMK less tedious. Let's do that now!
+
+Most people new to QMK only have 1 keyboard. You can set this keyboard as your default with the `qmk config` command. For example, to set your default keyboard to `clueboard/66/rev4`:
+
+ qmk config user.keyboard=clueboard/66/rev4
+
+You can also set your default keymap name. Most people use their github username here, and we recommend that you do too.
+
+ qmk config user.keymap=<github_username>
+
# 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.