From e40d7048d4c3f2e03c797097289041fbbacc060e Mon Sep 17 00:00:00 2001 From: TJ DeVries Date: Thu, 16 Feb 2023 17:02:01 -0500 Subject: [PATCH] more docs --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5ed5900..93d67ad 100644 --- a/README.md +++ b/README.md @@ -21,17 +21,20 @@ Kickstart.nvim targets *only* the latest ['stable'](https://github.com/neovim/ne * Restart Neovim Additional system requirements: -- Make sure to review the readmes of the plugins in the plugin list if anything is missing. In particular: +- Make sure to review the readmes of the plugins if you are experiencing errors. In particular: - [ripgrep](https://github.com/BurntSushi/ripgrep#installation) is required for multiple [telescope](https://github.com/nvim-telescope/telescope.nvim#suggested-dependencies) pickers. +- See as well [Windows Installation] -### Configuration +### Usage -* Fork this repo so that you have your own copy. +* Fork this repo (so that you have your own copy that you can modify). * Inside of your fork, feel free to modify any file you like! It's your fork! * Then there are two primary configuration options available: * Include the `lua/kickstart/plugins/*` files in your configuration. * Add new configuration in `lua/custom/plugins/*` files, which will be auto sourced using `lazy.nvim` +You can also merge updates/changes from the repo back into your fork, to keep up-to-date with any changes for the default configuration + #### Example: Adding an autopairs plugin In the file: `lua/custom/plugins/autopairs.lua`, add: @@ -71,8 +74,11 @@ Each PR, especially those which increase the line count, should have a descripti ### FAQ * What should I do if I already have a pre-existing neovim configuration? - * You should back it up, then delete all files associated with it. - * This includes your existing init.lua and the neovim files in `.local` which can be deleted with `rm -rf ~/.local/share/nvim/` + * You should back it up, then delete all files associated with it. + * This includes your existing init.lua and the neovim files in `~/.local` which can be deleted with `rm -rf ~/.local/share/nvim/` + * You may also want to look at the [migration guide for lazy.nvim](https://github.com/folke/lazy.nvim#-migration-guide) +* What if I want to "uninstall" this configuration: + * See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information * Are there any cool videos about this plugin? * Current iteration of kickstart (coming soon) * Here is one about the previous iteration of kickstart: [video introduction to Kickstart.nvim](https://youtu.be/stqUbv-5u2s).