diff options
Diffstat (limited to 'docs/newbs_getting_started.md')
-rw-r--r-- | docs/newbs_getting_started.md | 89 |
1 files changed, 75 insertions, 14 deletions
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md index 5eb99377c..3793fe767 100644 --- a/docs/newbs_getting_started.md +++ b/docs/newbs_getting_started.md | |||
@@ -37,26 +37,45 @@ We've tried to make QMK as easy to set up as possible. You only have to prepare | |||
37 | [Must Know Linux Commands](https://www.guru99.com/must-know-linux-commands.html)<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) | 38 | [Some Basic Unix Commands](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html) |
39 | 39 | ||
40 | ### Windows | 40 | <!-- tabs:start --> |
41 | 41 | ||
42 | You will need to install MSYS2, Git, and the QMK CLI. | 42 | ### ** Windows ** |
43 | 43 | ||
44 | Follow the installation instructions on the [MSYS2 homepage](http://www.msys2.org). Close any open MSYS terminals and open a new MinGW 64-bit terminal. **NOTE: This is *not* the same as the MSYS terminal that opens when installation is completed.** | 44 | #### Prerequisites |
45 | 45 | ||
46 | Then, run the following: | 46 | You will need to install MSYS2, Git and Python. Follow the installation instructions on https://www.msys2.org. |
47 | |||
48 | Once MSYS2 is installed, close any open MSYS terminals and open a new MinGW 64-bit terminal. | ||
49 | |||
50 | !> **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. | ||
51 | |||
52 | Then run the following command: | ||
47 | 53 | ||
48 | pacman --needed --noconfirm --disable-download-timeout -S git mingw-w64-x86_64-toolchain mingw-w64-x86_64-python3-pip | 54 | pacman --needed --noconfirm --disable-download-timeout -S git mingw-w64-x86_64-toolchain mingw-w64-x86_64-python3-pip |
55 | |||
56 | #### Installation | ||
57 | |||
58 | Install the QMK CLI by running: | ||
59 | |||
49 | python3 -m pip install qmk | 60 | python3 -m pip install qmk |
50 | 61 | ||
51 | ### macOS | 62 | ### ** macOS ** |
63 | |||
64 | QMK maintains a Homebrew tap and formula which will automatically install the CLI and all necessary dependencies. | ||
65 | |||
66 | #### Prerequisites | ||
52 | 67 | ||
53 | You will need to install Homebrew. Follow the instructions on the [Homebrew homepage](https://brew.sh). | 68 | You will need to install Homebrew. Follow the instructions on https://brew.sh. |
54 | 69 | ||
55 | After Homebrew is installed run this command: | 70 | #### Installation |
71 | |||
72 | Install the QMK CLI by running: | ||
56 | 73 | ||
57 | brew install qmk/qmk/qmk | 74 | brew install qmk/qmk/qmk |
58 | 75 | ||
59 | ### Linux | 76 | ### ** Linux/WSL ** |
77 | |||
78 | #### Prerequisites | ||
60 | 79 | ||
61 | 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: | 80 | 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: |
62 | 81 | ||
@@ -68,29 +87,61 @@ You will need to install Git and Python. It's very likely that you already have | |||
68 | * Sabayon: `sudo equo install dev-vcs/git dev-python/pip` | 87 | * Sabayon: `sudo equo install dev-vcs/git dev-python/pip` |
69 | * Gentoo: `sudo emerge dev-vcs/git dev-python/pip` | 88 | * Gentoo: `sudo emerge dev-vcs/git dev-python/pip` |
70 | 89 | ||
71 | Install the global CLI to bootstrap your system: | 90 | #### Installation |
72 | 91 | ||
73 | `python3 -m pip install --user qmk` (on Arch-based distros you can also try the `qmk` package from AUR (**note**: it's maintained by a community member): `yay -S qmk`) | 92 | Install the QMK CLI by running: |
74 | 93 | ||
75 | ### FreeBSD | 94 | python3 -m pip install --user qmk |
95 | |||
96 | On Arch-based distros you can also try the `qmk` package from AUR (**NOTE**: this package is maintained by a community member, and at the time of writing marks some dependencies as optional that should not be): | ||
97 | |||
98 | yay -S qmk | ||
99 | |||
100 | ### ** FreeBSD ** | ||
101 | |||
102 | #### Prerequisites | ||
76 | 103 | ||
77 | You will need to install Git and Python. It's possible that you already have both, but if not, run the following commands to install them: | 104 | You will need to install Git and Python. It's possible that you already have both, but if not, run the following commands to install them: |
78 | 105 | ||
79 | pkg install git python3 | 106 | pkg install git python3 |
80 | 107 | ||
81 | Make sure that `$HOME/.local/bin` is added to your `$PATH` so that locally install Python packages are available. | 108 | Make sure that `$HOME/.local/bin` is added to your `$PATH` so that locally installed Python packages are available. |
82 | 109 | ||
83 | Once installed, you can install QMK CLI: | 110 | #### Installation |
111 | |||
112 | Install the QMK CLI by running: | ||
84 | 113 | ||
85 | python3 -m pip install --user qmk | 114 | python3 -m pip install --user qmk |
86 | 115 | ||
116 | <!-- tabs:end --> | ||
117 | |||
87 | ## 3. Run QMK Setup :id=set-up-qmk | 118 | ## 3. Run QMK Setup :id=set-up-qmk |
88 | 119 | ||
120 | <!-- tabs:start --> | ||
121 | |||
122 | ### ** Windows ** | ||
123 | |||
89 | After installing QMK you can set it up with this command: | 124 | After installing QMK you can set it up with this command: |
90 | 125 | ||
91 | qmk setup | 126 | qmk setup |
92 | 127 | ||
93 | In most situations you will want to answer Yes to all of the prompts. | 128 | In most situations you will want to answer `y` to all of the prompts. |
129 | |||
130 | ### ** macOS ** | ||
131 | |||
132 | After installing QMK you can set it up with this command: | ||
133 | |||
134 | qmk setup | ||
135 | |||
136 | In most situations you will want to answer `y` to all of the prompts. | ||
137 | |||
138 | ### ** Linux/WSL ** | ||
139 | |||
140 | After installing QMK you can set it up with this command: | ||
141 | |||
142 | qmk setup | ||
143 | |||
144 | In most situations you will want to answer `y` to all of the prompts. | ||
94 | 145 | ||
95 | ?>**Note on Debian, Ubuntu and their derivatives**: | 146 | ?>**Note on Debian, Ubuntu and their derivatives**: |
96 | It's possible, that you will get an error saying something like: `bash: qmk: command not found`. | 147 | It's possible, that you will get an error saying something like: `bash: qmk: command not found`. |
@@ -98,12 +149,22 @@ This is due to a [bug](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=839155) | |||
98 | Sadly, Ubuntu reitroduced this bug and is [yet to fix it](https://bugs.launchpad.net/ubuntu/+source/bash/+bug/1588562). | 149 | Sadly, Ubuntu reitroduced this bug and is [yet to fix it](https://bugs.launchpad.net/ubuntu/+source/bash/+bug/1588562). |
99 | Luckily, the fix is easy. Run this as your user: `echo 'PATH="$HOME/.local/bin:$PATH"' >> $HOME/.bashrc && source $HOME/.bashrc` | 150 | Luckily, the fix is easy. Run this as your user: `echo 'PATH="$HOME/.local/bin:$PATH"' >> $HOME/.bashrc && source $HOME/.bashrc` |
100 | 151 | ||
152 | ### ** FreeBSD ** | ||
153 | |||
154 | After installing QMK you can set it up with this command: | ||
155 | |||
156 | qmk setup | ||
157 | |||
158 | In most situations you will want to answer `y` to all of the prompts. | ||
159 | |||
101 | ?>**Note on FreeBSD**: | 160 | ?>**Note on FreeBSD**: |
102 | It is suggested to run `qmk setup` as a non-`root` user to start with, but this will likely identify packages that need to be installed to your | 161 | It is suggested to run `qmk setup` as a non-`root` user to start with, but this will likely identify packages that need to be installed to your |
103 | base system using `pkg`. However the installation will probably fail when run as an unprivileged user. | 162 | base system using `pkg`. However the installation will probably fail when run as an unprivileged user. |
104 | To manually install the base dependencies, run `./util/qmk_install.sh` either as `root`, or with `sudo`. | 163 | To manually install the base dependencies, run `./util/qmk_install.sh` either as `root`, or with `sudo`. |
105 | Once that completes, re-run `qmk setup` to complete the setup and checks. | 164 | Once that completes, re-run `qmk setup` to complete the setup and checks. |
106 | 165 | ||
166 | <!-- tabs:end --> | ||
167 | |||
107 | ?> 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>/qmk_firmware` to clone your personal fork. If you don't know what that means you can safely ignore this message. | 168 | ?> 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>/qmk_firmware` to clone your personal fork. If you don't know what that means you can safely ignore this message. |
108 | 169 | ||
109 | ## 4. Test Your Build Environment | 170 | ## 4. Test Your Build Environment |