aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/index.html5
-rw-r--r--docs/newbs_getting_started.md89
-rw-r--r--docs/qmk_custom_dark.css17
-rw-r--r--docs/qmk_custom_light.css17
4 files changed, 114 insertions, 14 deletions
diff --git a/docs/index.html b/docs/index.html
index 5cab97a57..5312b9105 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -126,6 +126,10 @@
126 headings: 'h1, h2', 126 headings: 'h1, h2',
127 title: 'Table of Contents', 127 title: 'Table of Contents',
128 }, 128 },
129 tabs: {
130 persist : false,
131 tabComments: false,
132 },
129 plugins: [ 133 plugins: [
130 function (hook, vm) { 134 function (hook, vm) {
131 hook.beforeEach(function (html) { 135 hook.beforeEach(function (html) {
@@ -148,6 +152,7 @@
148 <script src="//unpkg.com/docsify/lib/docsify.min.js"></script> 152 <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
149 <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script> 153 <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
150 <script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script> 154 <script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
155 <script src="//unpkg.com/docsify-tabs@1"></script>
151 <script src="//unpkg.com/docsify-copy-code@2"></script> 156 <script src="//unpkg.com/docsify-copy-code@2"></script>
152 <script src="//unpkg.com/docsify-toc@1.0.0/dist/toc.js"></script> 157 <script src="//unpkg.com/docsify-toc@1.0.0/dist/toc.js"></script>
153 <script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script> 158 <script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
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
42You will need to install MSYS2, Git, and the QMK CLI. 42### ** Windows **
43 43
44Follow 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
46Then, run the following: 46You will need to install MSYS2, Git and Python. Follow the installation instructions on https://www.msys2.org.
47
48Once 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
52Then 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
58Install 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
64QMK maintains a Homebrew tap and formula which will automatically install the CLI and all necessary dependencies.
65
66#### Prerequisites
52 67
53You will need to install Homebrew. Follow the instructions on the [Homebrew homepage](https://brew.sh). 68You will need to install Homebrew. Follow the instructions on https://brew.sh.
54 69
55After Homebrew is installed run this command: 70#### Installation
71
72Install 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
61You 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: 80You 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
71Install 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`) 92Install the QMK CLI by running:
74 93
75### FreeBSD 94 python3 -m pip install --user qmk
95
96On 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
77You 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: 104You 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
81Make sure that `$HOME/.local/bin` is added to your `$PATH` so that locally install Python packages are available. 108Make sure that `$HOME/.local/bin` is added to your `$PATH` so that locally installed Python packages are available.
82 109
83Once installed, you can install QMK CLI: 110#### Installation
111
112Install 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
89After installing QMK you can set it up with this command: 124After installing QMK you can set it up with this command:
90 125
91 qmk setup 126 qmk setup
92 127
93In most situations you will want to answer Yes to all of the prompts. 128In most situations you will want to answer `y` to all of the prompts.
129
130### ** macOS **
131
132After installing QMK you can set it up with this command:
133
134 qmk setup
135
136In most situations you will want to answer `y` to all of the prompts.
137
138### ** Linux/WSL **
139
140After installing QMK you can set it up with this command:
141
142 qmk setup
143
144In 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**:
96It's possible, that you will get an error saying something like: `bash: qmk: command not found`. 147It'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)
98Sadly, Ubuntu reitroduced this bug and is [yet to fix it](https://bugs.launchpad.net/ubuntu/+source/bash/+bug/1588562). 149Sadly, Ubuntu reitroduced this bug and is [yet to fix it](https://bugs.launchpad.net/ubuntu/+source/bash/+bug/1588562).
99Luckily, the fix is easy. Run this as your user: `echo 'PATH="$HOME/.local/bin:$PATH"' >> $HOME/.bashrc && source $HOME/.bashrc` 150Luckily, 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
154After installing QMK you can set it up with this command:
155
156 qmk setup
157
158In most situations you will want to answer `y` to all of the prompts.
159
101?>**Note on FreeBSD**: 160?>**Note on FreeBSD**:
102It 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 161It 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
103base system using `pkg`. However the installation will probably fail when run as an unprivileged user. 162base system using `pkg`. However the installation will probably fail when run as an unprivileged user.
104To manually install the base dependencies, run `./util/qmk_install.sh` either as `root`, or with `sudo`. 163To manually install the base dependencies, run `./util/qmk_install.sh` either as `root`, or with `sudo`.
105Once that completes, re-run `qmk setup` to complete the setup and checks. 164Once 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
diff --git a/docs/qmk_custom_dark.css b/docs/qmk_custom_dark.css
index a7feb159c..c7fe7b7da 100644
--- a/docs/qmk_custom_dark.css
+++ b/docs/qmk_custom_dark.css
@@ -27,3 +27,20 @@
27.markdown-section hr, .search { 27.markdown-section hr, .search {
28 border-bottom: 1px solid #777 !important; 28 border-bottom: 1px solid #777 !important;
29} 29}
30
31
32:root {
33 --docsifytabs-border-color: #555;
34 --docsifytabs-tab-highlight-color: var(--theme-color,#ea6f5a);
35
36 --docsifytabs-tab-background: #444;
37 --docsifytabs-tab-background-active: #3f3f3f;
38}
39
40.docsify-tabs__tab:focus {
41 outline: none !important;
42}
43
44.docsify-tabs__content .anchor {
45 transition: none;
46}
diff --git a/docs/qmk_custom_light.css b/docs/qmk_custom_light.css
index 07b26ecec..c5d36cf6f 100644
--- a/docs/qmk_custom_light.css
+++ b/docs/qmk_custom_light.css
@@ -28,3 +28,20 @@
28.markdown-section pre { 28.markdown-section pre {
29 padding: 0; 29 padding: 0;
30} 30}
31
32
33:root {
34 --docsifytabs-border-color: #ddd;
35 --docsifytabs-tab-highlight-color: var(--theme-color, #0074d9);
36
37 --docsifytabs-tab-background: #f8f8f8;
38 --docsifytabs-tab-background-active: transparent;
39}
40
41.docsify-tabs__tab:focus {
42 outline: none !important;
43}
44
45.docsify-tabs__content .anchor {
46 transition: none;
47}