aboutsummaryrefslogtreecommitdiff
path: root/docs/newbs_getting_started.md
diff options
context:
space:
mode:
authorMateusz Piotrowski <mpp302@gmail.com>2021-05-07 19:22:05 +0200
committerGitHub <noreply@github.com>2021-05-07 19:22:05 +0200
commit189e0d5b983088342aee58e9e1d5dd76c0ace384 (patch)
tree414a22f80ff094e31e35198e83ce804829b534da /docs/newbs_getting_started.md
parent56e5a83e682a862673f9b127ad6a2b5626198a7f (diff)
downloadqmk_firmware-189e0d5b983088342aee58e9e1d5dd76c0ace384.tar.gz
qmk_firmware-189e0d5b983088342aee58e9e1d5dd76c0ace384.zip
Update FreeBSD install method (#12815)
The easiest way to install QMK CLI and all the necessary dependencies on FreeBSD is to use the packages from the official FreeBSD Ports Collection. This is possible since QMK CLI has been added to the Ports Collection: https://www.freshports.org/sysutils/py-qmk/
Diffstat (limited to 'docs/newbs_getting_started.md')
-rw-r--r--docs/newbs_getting_started.md20
1 files changed, 4 insertions, 16 deletions
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md
index ff8337f38..b434a04bb 100644
--- a/docs/newbs_getting_started.md
+++ b/docs/newbs_getting_started.md
@@ -104,19 +104,13 @@ You can also try the `qmk-git` package from AUR:
104 104
105### ** FreeBSD ** 105### ** FreeBSD **
106 106
107#### Prerequisites
108
109You 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:
110
111 pkg install git python3
112
113Make sure that `$HOME/.local/bin` is added to your `$PATH` so that locally installed Python packages are available.
114
115#### Installation 107#### Installation
116 108
117Install the QMK CLI by running: 109Install the FreeBSD package for QMK CLI by running:
118 110
119 python3 -m pip install --user qmk 111 pkg install -g "py*-qmk"
112
113NOTE: remember to follow the instructions printed at the end of installation (use `pkg info -Dg "py*-qmk"` to show them again).
120 114
121<!-- tabs:end --> 115<!-- tabs:end -->
122 116
@@ -162,12 +156,6 @@ After installing QMK you can set it up with this command:
162 156
163In most situations you will want to answer `y` to all of the prompts. 157In most situations you will want to answer `y` to all of the prompts.
164 158
165?>**Note on FreeBSD**:
166It 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
167base system using `pkg`. However the installation will probably fail when run as an unprivileged user.
168To manually install the base dependencies, run `./util/qmk_install.sh` either as `root`, or with `sudo`.
169Once that completes, re-run `qmk setup` to complete the setup and checks.
170
171<!-- tabs:end --> 159<!-- tabs:end -->
172 160
173?> The qmk home folder can be specified at setup with `qmk setup -H <path>`, and modified afterwards using the [cli configuration](cli_configuration.md?id=single-key-example) and the variable `user.qmk_home`. For all available options run `qmk setup --help`. 161?> The qmk home folder can be specified at setup with `qmk setup -H <path>`, and modified afterwards using the [cli configuration](cli_configuration.md?id=single-key-example) and the variable `user.qmk_home`. For all available options run `qmk setup --help`.