piwalker/kickstart.nvim
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
ce463f704b
kickstart.nvim/README.md

30 lines
1.5 KiB
Markdown
Raw Normal View History

init: kickstart.nvim
2022-06-23 21:35:53 -06:00
### Introduction
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'.
2022-11-09 08:27:08 -07:00
A starting point for Neovim that is:
init: kickstart.nvim
2022-06-23 21:35:53 -06:00
* Small (~325 lines)
* Single-file
* Documented
* Modular
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'.
2022-11-09 08:27:08 -07:00
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).
init: kickstart.nvim
2022-06-23 21:35:53 -06:00
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
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'.
2022-11-09 08:27:08 -07:00
init: kickstart.nvim
2022-06-23 21:35:53 -06:00
* Backup your previous configuration
* Copy and paste the kickstart.nvim `init.lua` into `$HOME/.config/nvim/init.lua`
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'.
2022-11-09 08:27:08 -07:00
* Start Neovim (`nvim`) and run `:PackerInstall` - ignore any error message about missing plugins, `:PackerInstall` will fix that shortly
* Restart Neovim
init: kickstart.nvim
2022-06-23 21:35:53 -06:00
### Contribution
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'.
2022-11-09 08:27:08 -07:00
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:
init: kickstart.nvim
2022-06-23 21:35:53 -06:00
* Custom language server configuration (null-ls templates)
* Theming beyond a default colorscheme necessary for LSP highlight groups
* Lazy-loading. Kickstart.nvim should start within 40 ms on modern hardware. Please profile and contribute to upstream plugins to optimize startup time instead.
Each PR, especially those which increase the line count, should have a description as to why the PR is necessary.
Reference in New Issue Copy Permalink