Skip to content

Commit ffe2ba0

Browse files
committed
feat(readme): clarify _windows_ install recipe
Rework the ordering and create a single command for all deps. Add additional detail on compiler, minimal installs, etc.
1 parent 267fb6a commit ffe2ba0

1 file changed

Lines changed: 55 additions & 11 deletions

File tree

README.md

Lines changed: 55 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,55 @@ After installing all the dependencies continue with the [Install Kickstart](#ins
178178
179179
#### Windows Installation
180180
181-
<details><summary>Windows with Microsoft C++ Build Tools and CMake</summary>
181+
<details><summary>Windows</summary>
182+
<details><summary>Chocolatey Install</summary>
183+
184+
Install [chocolatey](https://chocolatey.org/install)
185+
Either follow the instructions on the page or use `winget`,
186+
Run in cmd as **admin**:
187+
```
188+
winget install --accept-source-agreements chocolatey.chocolatey
189+
```
190+
</details>
191+
192+
With _Chocolatey_ already installed, use the below. See additional detail for minimal installs or non standard installs.
193+
```
194+
choco install -y neovim git ripgrep wget fd unzip gzip tree-sitter visualstudio2026buildtools visualstudio2026-workload-vctools mingw make
195+
```
196+
<details><summary>Windows Detail</summary>
197+
<details><summary>General Dependencies</summary>
198+
199+
```
200+
choco install -y neovim git ripgrep wget fd unzip gzip tree-sitter
201+
```
202+
</details>
203+
<details><summary>Windows Microsoft C++ Build Tools</summary>
204+
205+
The tools are required by the `tree-sitter` command line tool which is used by the `nvim-treesitter` plugin. This is the recommended way for a typical Windows install outside of _MSYS2_ , _Git Bash_, etc.
206+
207+
The below installs the base build tools and the [_Microsoft_](https://learn.microsoft.com/en-us/visualstudio/install/workload-component-id-vs-build-tools?view=visualstudio) recommended _Visual C_ workload and components. Installing it this way is recommended by the _Chocolatey_ package maintainer and allows for easier upgrades, etc. The dependency requires the compiler ( e.g. `cl.exe` ) and header files like `stdlib.h` in the _Windows_ SDK.
208+
```
209+
choco install -y visualstudio2026buildtools visualstudio2026-workload-vctools
210+
```
211+
<details><summary>Check Previous Install</summary>
212+
213+
If you already are a _Visual Studio_ user with _C_ workloads, you may not require the build tools. You can check your installation with the below to make sure the applicable workload and components are available. It should output something like _Visual Studio Community_ or _Microsoft Visual Studio Build Tools_. If you don't receive any output and you aren't using preview builds, etc, you may need to install the tools.
214+
```
215+
powershell -NoExit -Command "& 'C:\Program Files (x86)\Microsoft Visual Studio\Installer\vswhere.exe' -latest -sort -products * -requires Microsoft.VisualStudio.Workload.VCTools Microsoft.VisualStudio.Component.VC.Tools.x86.x64 Microsoft.VisualStudio.Component.Windows11SDK.26100 -property displayName -format value"
216+
```
217+
218+
If you do not have the `vswhere.exe` binary in that location you can download the [`release`](https://github.com/microsoft/vswhere) directly. It is available too with `choco install vswhere -y`.
219+
</details>
220+
221+
<details><summary>Minimal Install</summary>
222+
223+
The below will install the minimum required for a successful config. If one wants to upgrade or add additional components, it may be necessary to install the `visualstudio2026-workload-vctools` later or use the _Visual Studio Installer_.
224+
```
225+
choco install visualstudio2026buildtools -y --package-parameters "--add Microsoft.VisualStudio.Workload.VCTools --add Microsoft.VisualStudio.Component.VC.Tools.x86.x64 --add Microsoft.VisualStudio.Component.Windows11SDK.26100"
226+
```
227+
</details>
228+
</details>
229+
<details><summary>telescope-fzf-native.nvim with Microsoft C++ Build Tools and CMake</summary>
182230
Kickstart's default config is make-only for `telescope-fzf-native.nvim`.
183231
If `make` is unavailable, the plugin is skipped.
184232
@@ -210,23 +258,19 @@ end
210258

211259
See `telescope-fzf-native` documentation for [build details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation).
212260
</details>
213-
<details><summary>Windows with gcc/make using chocolatey</summary>
261+
<details><summary>telescope-fzf-native.nvim with gcc/make using chocolatey</summary>
214262
Alternatively, one can install gcc and make which don't require changing the config,
215263
the easiest way is to use choco:
216264

217-
1. install [chocolatey](https://chocolatey.org/install)
218-
either follow the instructions on the page or use winget,
219-
run in cmd as **admin**:
220-
```
221-
winget install --accept-source-agreements chocolatey.chocolatey
222-
```
223-
224-
2. install all requirements using choco, exit the previous cmd and
265+
Install all requirements ( i.e. `gcc` and `make` ) using choco, exit the previous cmd and
225266
open a new one so that choco path is set, and run in cmd as **admin**:
267+
226268
```
227-
choco install -y neovim git ripgrep wget fd unzip gzip mingw make tree-sitter
269+
choco install -y mingw make
228270
```
229271
</details>
272+
</details>
273+
</details>
230274
<details><summary>WSL (Windows Subsystem for Linux)</summary>
231275

232276
```

0 commit comments

Comments
 (0)