Skip to content

Commit f204a71

Browse files
committed
Doc fixes
1 parent 450b347 commit f204a71

2 files changed

Lines changed: 28 additions & 8 deletions

File tree

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,8 @@ nvim
113113

114114
That's it! `vim.pack` will install all the plugins from your config. Use
115115
`:lua vim.pack.update(nil, { offline = true })` to inspect plugin state and
116-
`:lua vim.pack.update()` to fetch updates.
116+
`:lua vim.pack.update()` to fetch updates (`:write` applies updates, `:quit`
117+
cancels them).
117118

118119
#### Read The Friendly Documentation
119120

@@ -169,17 +170,36 @@ After installing all the dependencies continue with the [Install Kickstart](#ins
169170
#### Windows Installation
170171
171172
<details><summary>Windows with Microsoft C++ Build Tools and CMake</summary>
172-
Installation may require installing build tools and updating the run command for `telescope-fzf-native`
173+
Kickstart's default config is make-only for `telescope-fzf-native.nvim`.
174+
If `make` is unavailable, the plugin is skipped.
173175
174-
See `telescope-fzf-native` documentation for [more details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation)
176+
Recommended: install `make` (see the chocolatey section below).
175177
176-
This requires:
178+
If you want a CMake-only setup, customize `init.lua` in two places:
177179
178-
- Install CMake and the Microsoft C++ Build Tools on Windows
180+
1. Include `telescope-fzf-native.nvim` when `cmake` is available:
179181
180182
```lua
181-
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
183+
if vim.fn.executable 'make' == 1 or vim.fn.executable 'cmake' == 1 then
184+
table.insert(plugins, gh 'nvim-telescope/telescope-fzf-native.nvim')
185+
end
182186
```
187+
188+
2. In the `PackChanged` hook, use CMake when `make` is unavailable:
189+
190+
```lua
191+
if name == 'telescope-fzf-native.nvim' then
192+
if vim.fn.executable 'make' == 1 then
193+
run_build(name, { 'make' }, ev.data.path)
194+
elseif vim.fn.executable 'cmake' == 1 then
195+
run_build(name, { 'cmake', '-S.', '-Bbuild', '-DCMAKE_BUILD_TYPE=Release' }, ev.data.path)
196+
run_build(name, { 'cmake', '--build', 'build', '--config', 'Release', '--target', 'install' }, ev.data.path)
197+
end
198+
return
199+
end
200+
```
201+
202+
See `telescope-fzf-native` documentation for [build details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation).
183203
</details>
184204
<details><summary>Windows with gcc/make using chocolatey</summary>
185205
Alternatively, one can install gcc and make which don't require changing the config,

init.lua

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -808,11 +808,11 @@ statusline.section_location = function() return '%2l:%-2v' end
808808
-- Check out: https://github.com/nvim-mini/mini.nvim
809809

810810
-- [[ Configure Treesitter ]]
811-
-- Used ighlight, edit, and navigate code
811+
-- Used to highlight, edit, and navigate code
812812
--
813813
-- See `:help nvim-treesitter-intro`
814814

815-
-- ensure basic parser are installed
815+
-- ensure basic parsers are installed
816816
local parsers = { 'bash', 'c', 'diff', 'html', 'lua', 'luadoc', 'markdown', 'markdown_inline', 'query', 'vim', 'vimdoc' }
817817
require('nvim-treesitter').install(parsers)
818818

0 commit comments

Comments
 (0)