Skip to content

Commit 0ecedb6

Browse files
authored
Merge branch 'master' into master
2 parents fa1358e + 0619d89 commit 0ecedb6

File tree

12 files changed

+418
-437
lines changed

12 files changed

+418
-437
lines changed

.github/workflows/stylua.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,12 @@ jobs:
99
runs-on: ubuntu-latest
1010
steps:
1111
- name: Checkout Code
12-
uses: actions/checkout@v2
12+
uses: actions/checkout@v6
1313
with:
1414
ref: ${{ github.event.pull_request.head.sha }}
1515
- name: Stylua Check
16-
uses: JohnnyMorganz/stylua-action@v3
16+
uses: JohnnyMorganz/stylua-action@v4
1717
with:
1818
token: ${{ secrets.GITHUB_TOKEN }}
1919
version: latest
2020
args: --check .
21-

.stylua.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ indent_type = "Spaces"
44
indent_width = 2
55
quote_style = "AutoPreferSingle"
66
call_parentheses = "None"
7+
collapse_simple_statement = "Always"

README.md

Lines changed: 90 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,22 @@ A starting point for Neovim that is:
1717
Kickstart.nvim targets *only* the latest
1818
['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest
1919
['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim.
20-
If you are experiencing issues, please make sure you have the latest versions.
20+
If you are experiencing issues, please make sure you have at least the latest
21+
stable version. Most likely, you want to install neovim via a [package
22+
manager](https://github.com/neovim/neovim/blob/master/INSTALL.md#install-from-package).
23+
To check your neovim version, run `nvim --version` and make sure it is not
24+
below the latest
25+
['stable'](https://github.com/neovim/neovim/releases/tag/stable) version. If
26+
your chosen install method only gives you an outdated version of neovim, find
27+
alternative [installation methods below](#alternative-neovim-installation-methods).
2128

2229
### Install External Dependencies
2330

2431
External Requirements:
2532
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
2633
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation),
2734
[fd-find](https://github.com/sharkdp/fd#installation)
35+
- [tree-sitter CLI](https://github.com/tree-sitter/tree-sitter/blob/master/crates/cli/README.md#installation)
2836
- Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
2937
- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons
3038
- if you have it set `vim.g.have_nerd_font` in `init.lua` to true
@@ -154,7 +162,7 @@ examples of adding popularly requested plugins.
154162
155163
Below you can find OS specific install instructions for Neovim and dependencies.
156164
157-
After installing all the dependencies continue with the [Install Kickstart](#Install-Kickstart) step.
165+
After installing all the dependencies continue with the [Install Kickstart](#install-kickstart) step.
158166
159167
#### Windows Installation
160168
@@ -185,7 +193,7 @@ winget install --accept-source-agreements chocolatey.chocolatey
185193
2. install all requirements using choco, exit the previous cmd and
186194
open a new one so that choco path is set, and run in cmd as **admin**:
187195
```
188-
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
196+
choco install -y neovim git ripgrep wget fd unzip gzip mingw make tree-sitter
189197
```
190198
</details>
191199
<details><summary>WSL (Windows Subsystem for Linux)</summary>
@@ -195,7 +203,7 @@ wsl --install
195203
wsl
196204
sudo add-apt-repository ppa:neovim-ppa/unstable -y
197205
sudo apt update
198-
sudo apt install make gcc ripgrep unzip git xclip neovim
206+
sudo apt install make gcc ripgrep fd-find tree-sitter-cli unzip git xclip neovim
199207
```
200208
</details>
201209

@@ -205,14 +213,14 @@ sudo apt install make gcc ripgrep unzip git xclip neovim
205213
```
206214
sudo add-apt-repository ppa:neovim-ppa/unstable -y
207215
sudo apt update
208-
sudo apt install make gcc ripgrep unzip git xclip neovim
216+
sudo apt install make gcc ripgrep fd-find tree-sitter-cli unzip git xclip neovim
209217
```
210218
</details>
211219
<details><summary>Debian Install Steps</summary>
212220

213221
```
214222
sudo apt update
215-
sudo apt install make gcc ripgrep unzip git xclip curl
223+
sudo apt install make gcc ripgrep fd-find tree-sitter-cli unzip git xclip curl
216224
217225
# Now we install nvim
218226
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux-x86_64.tar.gz
@@ -228,14 +236,88 @@ sudo ln -sf /opt/nvim-linux-x86_64/bin/nvim /usr/local/bin/
228236
<details><summary>Fedora Install Steps</summary>
229237

230238
```
231-
sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
239+
sudo dnf install -y gcc make git ripgrep fd-find tree-sitter-cli unzip neovim
232240
```
233241
</details>
234242

235243
<details><summary>Arch Install Steps</summary>
236244

237245
```
238-
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
246+
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd tree-sitter-cli unzip neovim
239247
```
240248
</details>
241249

250+
### Alternative neovim installation methods
251+
252+
For some systems it is not unexpected that the [package manager installation
253+
method](https://github.com/neovim/neovim/blob/master/INSTALL.md#install-from-package)
254+
recommended by neovim is significantly behind. If that is the case for you,
255+
pick one of the following methods that are known to deliver fresh neovim versions very quickly.
256+
They have been picked for their popularity and because they make installing and updating
257+
neovim to the latest versions easy. You can also find more detail about the
258+
available methods being discussed
259+
[here](https://github.com/nvim-lua/kickstart.nvim/issues/1583).
260+
261+
262+
<details><summary>Bob</summary>
263+
264+
[Bob](https://github.com/MordechaiHadad/bob) is a Neovim version manager for
265+
all platforms. Simply install
266+
[rustup](https://rust-lang.github.io/rustup/installation/other.html),
267+
and run the following commands:
268+
269+
```bash
270+
rustup default stable
271+
rustup update stable
272+
cargo install bob-nvim
273+
bob use stable
274+
```
275+
276+
</details>
277+
278+
<details><summary>Homebrew</summary>
279+
280+
[Homebrew](https://brew.sh) is a package manager popular on Mac and Linux.
281+
Simply install using [`brew install`](https://formulae.brew.sh/formula/neovim).
282+
283+
</details>
284+
285+
<details><summary>Flatpak</summary>
286+
287+
Flatpak is a package manager for applications that allows developers to package their applications
288+
just once to make it available on all Linux systems. Simply [install flatpak](https://flatpak.org/setup/)
289+
and setup [flathub](https://flathub.org/setup) to [install neovim](https://flathub.org/apps/io.neovim.nvim).
290+
291+
</details>
292+
293+
<details><summary>asdf and mise-en-place</summary>
294+
295+
[asdf](https://asdf-vm.com/) and [mise](https://mise.jdx.dev/) are tool version managers,
296+
mostly aimed towards project-specific tool versioning. However both support managing tools
297+
globally in the user-space as well:
298+
299+
<details><summary>mise</summary>
300+
301+
[Install mise](https://mise.jdx.dev/getting-started.html), then run:
302+
303+
```bash
304+
mise plugins install neovim
305+
mise use neovim@stable
306+
```
307+
308+
</details>
309+
310+
<details><summary>asdf</summary>
311+
312+
[Install asdf](https://asdf-vm.com/guide/getting-started.html), then run:
313+
314+
```bash
315+
asdf plugin add neovim
316+
asdf install neovim stable
317+
asdf set neovim stable --home
318+
asdf reshim neovim
319+
```
320+
321+
</details>
322+
323+
</details>

0 commit comments

Comments
 (0)