summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorC.D. MacEachern <craig.daniel.maceachern@gmail.com>2022-11-09 10:27:08 -0500
committerTJ DeVries <devries.timothyj@gmail.com>2022-11-18 15:15:22 -0500
commitce463f704bd0c3499acf1f2db49ba2cace37be5a (patch)
tree6eaa7f0c6b148f83f3ec001f6d92a6ed6b40d2ed /README.md
parentc8a140577832ed4f958f4964400b2591abea3825 (diff)
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'.
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/README.md b/README.md
index c523139..61b559a 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,26 @@
### Introduction
-A starting point for neovim that is:
+A starting point for Neovim that is:
* Small (~325 lines)
* Single-file
* Documented
* Modular
-Kickstart targets *only* the latest stable neovim release (0.7) and the nightly.
+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).
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).
### Installation
+
* Backup your previous configuration
* Copy and paste the kickstart.nvim `init.lua` into `$HOME/.config/nvim/init.lua`
-* start neovim (`nvim`) and run `:PackerInstall`, ignore any error message about missing plugins, `:PackerInstall` will fix that shortly.
-* restart neovim
+* Start Neovim (`nvim`) and run `:PackerInstall` - ignore any error message about missing plugins, `:PackerInstall` will fix that shortly
+* Restart Neovim
### Contribution
-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:
+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:
* Custom language server configuration (null-ls templates)
* Theming beyond a default colorscheme necessary for LSP highlight groups