nvim.d/README.asciidoc
2024-06-29 09:23:27 +01:00

70 lines
1.8 KiB
Text

= nvim.d
My Neovim configuration for neovim version 0.9.0+.
== Dependencies
== Installation
1. Clone the repository or download the latest package from the release page.
2. If you have existing neovim configuration you can take a backup of it.
Run the command below to create a timestamped tar archive of your existing config.
```
make backup
```
- install config with your XDG_CONIFIG_HOME dir (default is ~/.config)
```
make install
```
- install the lazy package manager
```
make install_lazy
```
- start neovim. when first launched the lazy package manager will proceed to install all missing plugins.
== Plugins
[%header,cols=3*]
|===
|Name
|Purpose
|Link to source
|folke/lazy.nvim
|Manages all other neovim plugins.
|https://github.com/folke/lazy.nvim
|folke/tokyonight.nvim
|Sets the Tokyonight colour scheme for neovim.
|https://github.com/folke/tokyonight.nvim
|neovim/nvim-lspconfig
|Makes configuring LSP settings in neovim much easier.
|https://github.com/neovim/nvim-lspconfig
|nvim-treesitter/nvim-treesitter
|An interface for treesitter to provide better highlighting among other functionalities.
|https://github.com/nvim-treesitter/nvim-treesitter
|akinsho/bufferline.nvim
|For visualising buffers and easy navigation between them.
|https://github.com/akinsho/bufferline.nvim
|nvim-tree/nvim-web-devicons
|Provides icons that are used in other plugins.
|https://github.com/nvim-tree/nvim-web-devicons
|is0n/tui-nvim
|Allows you to open terminal programs in neovim. Currently used to integration the LF file manager within neovim.
|https://github.com/is0n/tui-nvim
|mfussenegger/nvim-lint
|An asynchronous linter plugin complementary to the LSP client. Used for external linters such as golangci-lint and pyls.
|https://github.com/mfussenegger/nvim-lint
|===
== Key mappings
== Compatibility