diff options
| -rw-r--r-- | docs/newbs_getting_started.md | 20 |
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 | |||
| 109 | 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: | ||
| 110 | |||
| 111 | pkg install git python3 | ||
| 112 | |||
| 113 | Make 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 | ||
| 117 | Install the QMK CLI by running: | 109 | Install the FreeBSD package for QMK CLI by running: |
| 118 | 110 | ||
| 119 | python3 -m pip install --user qmk | 111 | pkg install -g "py*-qmk" |
| 112 | |||
| 113 | NOTE: 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 | ||
| 163 | In most situations you will want to answer `y` to all of the prompts. | 157 | In most situations you will want to answer `y` to all of the prompts. |
| 164 | 158 | ||
| 165 | ?>**Note on FreeBSD**: | ||
| 166 | 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 | ||
| 167 | base system using `pkg`. However the installation will probably fail when run as an unprivileged user. | ||
| 168 | To manually install the base dependencies, run `./util/qmk_install.sh` either as `root`, or with `sudo`. | ||
| 169 | Once 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`. |
