diff options
Diffstat (limited to 'docs/newbs_getting_started.md')
| -rw-r--r-- | docs/newbs_getting_started.md | 36 |
1 files changed, 8 insertions, 28 deletions
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md index 10a513050..1c72911d9 100644 --- a/docs/newbs_getting_started.md +++ b/docs/newbs_getting_started.md | |||
| @@ -2,41 +2,21 @@ | |||
| 2 | 2 | ||
| 3 | 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. | 3 | 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. |
| 4 | 4 | ||
| 5 | ## 1. Download Software | 5 | ## 1. Prerequisites |
| 6 | 6 | ||
| 7 | There are a few pieces of software you'll need to get started. | 7 | There are a few pieces of software you'll need to get started. |
| 8 | 8 | ||
| 9 | ### Text Editor | 9 | * [Text editor](newbs_learn_more_resources.md#text-editor-resources) |
| 10 | * 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. | ||
| 11 | * [Toolbox (optional)](https://github.com/qmk/qmk_toolbox) | ||
| 12 | * A graphical program for Windows and macOS that allows you to both program and debug your custom keyboard | ||
| 10 | 13 | ||
| 11 | You'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. | 14 | ?> 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. |
| 12 | |||
| 13 | You 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. | ||
| 14 | |||
| 15 | ?> Not sure which text editor to use? Laurence Bradford wrote [a great introduction](https://learntocodewith.me/programming/basics/text-editors/) to the subject. | ||
| 16 | |||
| 17 | ### QMK Toolbox | ||
| 18 | |||
| 19 | QMK 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. | ||
| 20 | |||
| 21 | [Download the latest release here.](https://github.com/qmk/qmk_toolbox/releases/latest) | ||
| 22 | |||
| 23 | * For Windows: `qmk_toolbox.exe` (portable) or `qmk_toolbox_install.exe` (installer) | ||
| 24 | * For macOS: `QMK.Toolbox.app.zip` (portable) or `QMK.Toolbox.pkg` (installer) | ||
| 25 | |||
| 26 | ### A Unix-like Environment | ||
| 27 | |||
| 28 | Linux and macOS come with unix shells you can execute already. You will only need to setup your build environment. | ||
| 29 | |||
| 30 | On Windows you will need to install MSYS2 or WSL and use those environments. Instructions for setting up MSYS2 are provided below. | ||
| 31 | 15 | ||
| 32 | ## 2. Prepare Your Build Environment :id=set-up-your-environment | 16 | ## 2. Prepare Your Build Environment :id=set-up-your-environment |
| 33 | 17 | ||
| 34 | 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. | 18 | 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. |
| 35 | 19 | ||
| 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 be able to work with QMK:<br> | ||
| 37 | [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) | ||
| 39 | |||
| 40 | <!-- tabs:start --> | 20 | <!-- tabs:start --> |
| 41 | 21 | ||
| 42 | ### ** Windows ** | 22 | ### ** Windows ** |
| @@ -45,9 +25,9 @@ QMK maintains a Bundle of MSYS2, the CLI and all necessary dependencies. It also | |||
| 45 | 25 | ||
| 46 | #### Prerequisites | 26 | #### Prerequisites |
| 47 | 27 | ||
| 48 | You will need to install `QMK MSYS`. The latest release is available at https://msys.qmk.fm/. | 28 | 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). |
| 49 | 29 | ||
| 50 | Alternatively, if you'd like to manually install msys2, the following section will walk you through the process. | 30 | Alternatively, if you'd like to manually install MSYS2, the following section will walk you through the process. |
| 51 | 31 | ||
| 52 | <details> | 32 | <details> |
| 53 | <summary>Manual Install</summary> | 33 | <summary>Manual Install</summary> |