Provide help in README and simplify module

This commit is contained in:
Elijah Manor 2022-11-20 18:45:31 -06:00
parent d395cbcdf5
commit 7e65b6a1fe
2 changed files with 34 additions and 2 deletions

View File

@ -12,11 +12,43 @@ Kickstart targets *only* the latest stable neovim release (0.7) and the 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
### Configuration
You could directly modify the `init.lua` file with your personal customizations. This option is the most straightforward, but if you update your config from this repo, you may need to reapply your changes.
An alternative approach is to create a separate `custom.plugins` module to register your own plugins. In addition, you can handle further customizations in a `after/plugin/defaults.lua` file. See the following examples for more information. Leveraging these files should make upgrading to a newer version of this repo easier.
#### Example `plugins.lua`
The following is an example of a `plugins.lua` file (located at `$HOME/.config/nvim/lua/custom/plugins.lua`) where you can register you own plugins.
```lua
return function(use)
use({
"folke/which-key.nvim",
config = function()
require("which-key").setup({})
end
})
end
```
#### Example `defaults.lua`
The following is an example `defaults.lua` file (localed at `$HOME/.config/nvim/after/plugin/defaults.lua`) where you can define your own options, keymaps, autogroups, and more.
```lua
vim.opt.relativenumber = true
vim.keymap.set('n', '<leader>sr', require('telescope.builtin').resume, { desc = '[S]earch [R]esume' })
```
### 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:

View File

@ -32,9 +32,9 @@ require('packer').startup(function(use)
-- Fuzzy Finder Algorithm which requires local dependencies to be built. Only load if `make` is available
use { 'nvim-telescope/telescope-fzf-native.nvim', run = 'make', cond = vim.fn.executable "make" == 1 }
-- Add custom plugins to packer from a /nvim/lua/custom/plugins.lua module
-- Add custom plugins to packer from /nvim/lua/custom/plugins.lua
local has_plugins, plugins = pcall(require, "custom.plugins")
if has_plugins then plugins.setup(use) end
if has_plugins then plugins(use) end
if is_bootstrap then
require('packer').sync()