Skip to content

Commit ce463f7

Browse files
craigmactjdevries
authored andcommitted
Update README.md
Use links to tagged releases rather than hardcoding 0.x and having to change it every few months. Fix markdownlint errors and some spelling, like using the official 'Neovim', not 'neovim'.
1 parent c8a1405 commit ce463f7

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
11
### Introduction
22

3-
A starting point for neovim that is:
3+
A starting point for Neovim that is:
44

55
* Small (~325 lines)
66
* Single-file
77
* Documented
88
* Modular
99

10-
Kickstart targets *only* the latest stable neovim release (0.7) and the nightly.
10+
Kickstart.nvim targets *only* the Neovim releases tagged ['stable'](https://github.com/neovim/neovim/releases/tag/stable) and ['nightly'](https://github.com/neovim/neovim/releases/tag/nightly).
1111

1212
This repo is meant to be used as a starting point for a user's own configuration; remove the things you don't use and add what you miss. This configuration serves as the reference configuration for the [lspconfig wiki](https://github.com/neovim/nvim-lspconfig/wiki).
1313

1414
### Installation
15+
1516
* Backup your previous configuration
1617
* Copy and paste the kickstart.nvim `init.lua` into `$HOME/.config/nvim/init.lua`
17-
* start neovim (`nvim`) and run `:PackerInstall`, ignore any error message about missing plugins, `:PackerInstall` will fix that shortly.
18-
* restart neovim
18+
* Start Neovim (`nvim`) and run `:PackerInstall` - ignore any error message about missing plugins, `:PackerInstall` will fix that shortly
19+
* Restart Neovim
1920

2021
### Contribution
2122

22-
Pull-requests are welcome. The goal of this repo is not to create a neovim configuration framework, but to offer a starting template that shows, by example, available features in neovim. Some things that will not be included:
23+
Pull-requests are welcome. The goal of this repo is not to create a Neovim configuration framework, but to offer a starting template that shows, by example, available features in Neovim. Some things that will not be included:
2324

2425
* Custom language server configuration (null-ls templates)
2526
* Theming beyond a default colorscheme necessary for LSP highlight groups

0 commit comments

Comments
 (0)