aboutsummaryrefslogtreecommitdiff
path: root/docs/newbs_getting_started.md
diff options
context:
space:
mode:
authorKonstantin Đorđević <vomindoraan@gmail.com>2018-11-06 21:21:44 +0100
committerDrashna Jaelre <drashna@live.com>2018-11-06 12:21:44 -0800
commit3dec80b7746ee61e4c9e67da817635828dd86b7f (patch)
treee518496e7f27f27593f1b5649e30d5c4269a600b /docs/newbs_getting_started.md
parenta5d22424f40cf386120008b5d44d810c62d0ffcb (diff)
downloadqmk_firmware-3dec80b7746ee61e4c9e67da817635828dd86b7f.tar.gz
qmk_firmware-3dec80b7746ee61e4c9e67da817635828dd86b7f.zip
Improve wording, punctuation and capitalization in newbs_getting_started guide (#4342)
* Improve wording, punctuation and capitalization in newbs_getting_started guide Also add some links * Update example build command output Co-Authored-By: vomindoraan <vomindoraan@gmail.com> * Replace occurrences of "layout" with "keymap" Co-Authored-By: MechMerlin <30334081+mechmerlin@users.noreply.github.com> * Explicitly instruct users to open an MSYS2 MinGW 64-bit terminal * MSYS2 Console → MSYS2 MinGW * Replace thin spaces with regular spaces
Diffstat (limited to 'docs/newbs_getting_started.md')
-rw-r--r--docs/newbs_getting_started.md78
1 files changed, 38 insertions, 40 deletions
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md
index 218154285..276c7fec3 100644
--- a/docs/newbs_getting_started.md
+++ b/docs/newbs_getting_started.md
@@ -1,99 +1,97 @@
1# Introduction 1# Introduction
2 2
3Your 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 they 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 layout you are creating the equivalent of an .exe for your keyboard. 3Your 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.
4 4
5QMK 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 layouts, you only have to follow a few simple syntax rules. 5QMK 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.
6 6
7# Getting Started 7# Getting Started
8 8
9Before you can build keymaps you need to install some software and setup your build environment. This only has to be done one time no matter how many keyboards you want to compile firmware for. 9Before 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.
10 10
11## Download Software 11## Download Software
12 12
13### Text Editor 13### Text Editor
14 14
15You'll need a program that can edit and save **plain text** files. If you are on Windows you can make due with Notepad, and on Linux you can use Gedit, both of which are simple but functional text editors. On macOS be careful with TextEdit.app, it will not save plain text files unless you make sure to select "Make Plain text" from the "Format" menu, or you can use another program such as Sublime Text. 15You'll need a program that can edit and save **plain text** files. If you're on Windows you can make do with Notepad, and on Linux you can use gedit. Both of these are simple but functional text editors. On macOS, be careful with the default TextEdit app: it will not save plain text files unless you explicitly select _Make Plain Text_ from the _Format_ menu.
16
17You can also download and install a dedicated text editor like [Sublime Text](https://www.sublimetext.com/) or [VS Code](https://code.visualstudio.com/). This is probably the best way to go regardless of platform, as these programs are specifically made for editing code.
16 18
17?> Not sure which text editor to use? Laurence Bradford wrote [a great introduction](https://learntocodewith.me/programming/basics/text-editors/) to the subject. 19?> Not sure which text editor to use? Laurence Bradford wrote [a great introduction](https://learntocodewith.me/programming/basics/text-editors/) to the subject.
18 20
19### QMK Toolbox 21### QMK Toolbox
20 22
21QMK Toolbox is an optional graphical Windows and macOS program that allows you to both program and debug your custom keyboard. You will likely prefer it to easily flash your keyboard and receive the debugging messages that your keyboard will print. 23QMK Toolbox is an optional graphical program for Windows and macOS that allows you to both program and debug your custom keyboard. You will likely find it invaluable for easily flashing your keyboard and viewing debug messages that it prints.
22
23Download the files from the links below:
24
25For Windows: "qmk_toolbox.exe" or "qmk_toolbox_install.exe" (with installer)
26 24
27For Mac: "QMK.Toolbox.app.zip" or "QMK.Toolbox.pkg" (with installer) 25[Download the latest release here.](https://github.com/qmk/qmk_toolbox/releases/latest)
28 26
29* [Newest Release](https://github.com/qmk/qmk_toolbox/releases/latest) 27* For Windows: `qmk_toolbox.exe` (portable) or `qmk_toolbox_install.exe` (installer)
30* [Source Code](https://github.com/qmk/qmk_toolbox/) 28* For macOS: `QMK.Toolbox.app.zip` (portable) or `QMK.Toolbox.pkg` (installer)
31 29
32## Environment Setup 30## Set Up Your Environment
33 31
34We've tried to make QMK as easy to setup as possible. You only have to prepare your Linux or Unix environment and let QMK install the rest. 32We'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.
35 33
36?> 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 will teach you enough to work with QMK:<br> 34?> 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 will teach you enough to be able to work with QMK:<br>
37[Must Know Linux Commands](https://www.guru99.com/must-know-linux-commands.html)<br> 35[Must Know Linux Commands](https://www.guru99.com/must-know-linux-commands.html)<br>
38[Some Basic Unix Commands](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html) 36[Some Basic Unix Commands](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html)
39 37
40### Windows 38### Windows
41 39
42You will need to install msys2 and git. 40You will need to install MSYS2 and Git.
43 41
44* Follow the installation instructions on the msys2 homepage: http://www.msys2.org 42* Follow the installation instructions on the [MSYS2 homepage](http://www.msys2.org).
45* Close any open msys2 terminals, and open a new terminal 43* Close any open MSYS2 terminals and open a new MSYS2 MinGW 64-bit terminal.
46* Install git by running this command: `pacman -S git` 44* Install Git by running this command: `pacman -S git`.
47 45
48### macOS 46### macOS
49 47
50You will need to install homebrew. Follow the instructions on the homebrew homepage: https://brew.sh 48You will need to install Homebrew. Follow the instructions on the [Homebrew homepage](https://brew.sh).
51 49
52After homebrew is installed continue with "Download QMK", following step "Setup QMK" runs a script that will install other packages. 50After Homebrew is installed, continue with _Set Up QMK_. In that step you will run a script that will install other packages.
53 51
54### Linux 52### Linux
55 53
56You will need to install git. It's extremely likely you already have it, but if not one of the following commands should install it: 54You 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:
57 55
58* Debian/Ubuntu/Devuan: `apt-get install git` 56* Debian / Ubuntu / Devuan: `apt-get install git`
59* Fedora/Redhat/Centos: `yum install git` 57* Fedora / Red Hat / CentOS: `yum install git`
60* Arch: `pacman -S git` 58* Arch: `pacman -S git`
61 59
62## Download QMK 60?> Docker is also an option on all platforms. [Click here for details.](getting_started_build_tools.md#docker)
63 61
64Once you have setup 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 Console window and leave it open for the remainder of this guide. Inside that window run these two commands: 62## Set Up QMK
63
64Once 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:
65 65
66 git clone https://github.com/qmk/qmk_firmware.git 66 git clone https://github.com/qmk/qmk_firmware.git
67 cd qmk_firmware 67 cd qmk_firmware
68 68
69?> If you already know [how to use GitHub](getting_started_github.md) we recommend you create and clone your own fork instead. If you don't know what that means you can safely ignore this message. 69?> 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.
70
71## Setup QMK
72 70
73QMK comes with a script to help you setup the rest of what you'll need. You should run it now by typing in this command: 71QMK 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:
74 72
75 ./util/qmk_install.sh 73 util/qmk_install.sh
76 74
77## Test Your Build Environment 75## Test Your Build Environment
78 76
79Now that your QMK build environment is setup you can build a firmware for your keyboard. Start by trying to build the default layout for your keyboard. You should be able to do that with a command in this format: 77Now 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:
80 78
81 make <keyboard>:default 79 make <keyboard>:default
82 80
83For example, to build a firmware for a Clueboard 66% use: 81For example, to build a firmware for a Clueboard 66% you would use:
84 82
85 make clueboard/66/rev3:default 83 make clueboard/66/rev3:default
86 84
87When it is done you should have a lot of output that ends similar to this: 85When it is done you should have a lot of output that ends similar to this:
88 86
89``` 87```
90Linking: .build/clueboard_66_rev2_default.elf [OK] 88Linking: .build/clueboard_66_rev3_default.elf [OK]
91Creating load file for flashing: .build/clueboard_66_rev2_default.hex [OK] 89Creating load file for flashing: .build/clueboard_66_rev3_default.hex [OK]
92Copying clueboard_66_rev2_default.hex to qmk_firmware folder [OK] 90Copying clueboard_66_rev3_default.hex to qmk_firmware folder [OK]
93Checking file size of clueboard_66_rev2_default.hex [OK] 91Checking file size of clueboard_66_rev3_default.hex [OK]
94 * File size is fine - 25174/28672 92 * The firmware size is fine - 26356/28672 (2316 bytes free)
95``` 93```
96 94
97## Creating Your Layout 95# Creating Your Keymap
98 96
99Now you are ready to create your own personal layout. Move on to [Building Your First Firmware](newbs_building_firmware.md) for that. 97You are now ready to create your own personal keymap! Move on to [Building Your First Firmware](newbs_building_firmware.md) for that.