From 39a941c3851fbadf08731601b9958785e50bee73 Mon Sep 17 00:00:00 2001 From: kazenix Date: Thu, 22 Dec 2022 04:45:20 -0800 Subject: [PATCH] Adding cmake documentation to README.md (#85) --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index b424085..e29f426 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,20 @@ This repo is meant to be used as a starting point for a user's own configuration If there are languages that you don't want to use, remove their configuration and notes from your `init.lua` after copy and pasting (for example, in the mason configuration). +### Windows Installation + +Installation may require installing build tools, and updating the run command for `telescope-fzf-native` + +See `telescope-fzf-native` documention for [more details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation) + +This requires: + +- Install CMake, and the Microsoft C++ Build Tools on Windows + +```lua +use {'nvim-telescope/telescope-fzf-native.nvim', run = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' } +``` + ### Configuration You could directly modify the `init.lua` file with your personal customizations. This option is the most straightforward, but if you update your config from this repo, you may need to reapply your changes.