Skip to content

Commit 8e4bcd6

Browse files
authored
Merge branch 'master' into master
2 parents 9a11777 + cfdc17b commit 8e4bcd6

11 files changed

Lines changed: 1073 additions & 945 deletions

File tree

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ nvim
66
spell/
77

88
# In your personal fork, you likely want to comment this, since it's recommended to track
9-
# lazy-lock.json in version control - see https://lazy.folke.io/usage/lockfile
9+
# nvim-pack-lock.json in version control - see :help vim.pack-lockfile
1010
# For the official `nvim-lua/kickstart.nvim` git repository, we leave it ignored to avoid unneeded
1111
# merge conflicts.
12-
lazy-lock.json
12+
nvim-pack-lock.json
1313

1414
.DS_Store

README.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,9 @@ fork to your machine using one of the commands below, depending on your OS.
6969
> Your fork's URL will be something like this:
7070
> `https://github.com/<your_github_username>/kickstart.nvim.git`
7171
72-
You likely want to remove `lazy-lock.json` from your fork's `.gitignore` file
73-
too - it's ignored in the kickstart repo to make maintenance easier, but it's
74-
[recommended to track it in version control](https://lazy.folke.io/usage/lockfile).
72+
You likely want to remove `nvim-pack-lock.json` from your fork's `.gitignore`
73+
file too - it's ignored in the kickstart repo to make maintenance easier, but
74+
it's recommended to track it in version control (see `:help vim.pack-lockfile`).
7575

7676
#### Clone kickstart.nvim
7777

@@ -111,8 +111,10 @@ Start Neovim
111111
nvim
112112
```
113113

114-
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
115-
the current plugin status. Hit `q` to close the window.
114+
That's it! `vim.pack` will install all the plugins from your config. Use
115+
`:lua vim.pack.update(nil, { offline = true })` to inspect plugin state and
116+
`:lua vim.pack.update()` to fetch updates (`:write` applies updates, `:quit`
117+
cancels them).
116118

117119
#### Read The Friendly Documentation
118120

@@ -146,7 +148,8 @@ examples of adding popularly requested plugins.
146148
`~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim
147149
distribution that you would like to try out.
148150
* What if I want to "uninstall" this configuration:
149-
* See [lazy.nvim uninstall](https://lazy.folke.io/usage#-uninstalling) information
151+
* Remove your config directory and local data directory (for example,
152+
`~/.config/nvim` and `~/.local/share/nvim`).
150153
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
151154
* The main purpose of kickstart is to serve as a teaching tool and a reference
152155
configuration that someone can easily use to `git clone` as a basis for their own.
@@ -167,17 +170,36 @@ After installing all the dependencies continue with the [Install Kickstart](#ins
167170
#### Windows Installation
168171
169172
<details><summary>Windows with Microsoft C++ Build Tools and CMake</summary>
170-
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.
171175
172-
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).
173177
174-
This requires:
178+
If you want a CMake-only setup, customize `init.lua` in two places:
175179
176-
- Install CMake and the Microsoft C++ Build Tools on Windows
180+
1. Include `telescope-fzf-native.nvim` when `cmake` is available:
177181
178182
```lua
179-
{'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
180186
```
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).
181203
</details>
182204
<details><summary>Windows with gcc/make using chocolatey</summary>
183205
Alternatively, one can install gcc and make which don't require changing the config,

0 commit comments

Comments
 (0)