This repository contains a custom Neovim configuration. Follow the instructions below to set up Neovim with this configuration.
- Neovim: Ensure Neovim is installed on your system. You can follow the installation guide from the Neovim official documentation.
-
Clone this repository into the Neovim configuration directory:
git clone https://github.com/your-username/your-repository.git ~/.config/nvim -
If you already have a .config/nvim directory, you may want to back it up before cloning the new configuration
mv ~/.config/nvim ~/.config/nvim.bak
-
Open Neovim Install the plugins defined in the configuration. The installation process will vary depending on the plugin manager you are using. If you're using vim-plug, run:
:PlugInstall
-
If you're using packer.nvim, run:
:PackerSync
- Custom Commands: The GNUmakefile in this repository defines some custom commands for managing plugins. You can use make fetch-packs to initialize and update submodules, and make update-packs to update plugins.
To use these commands, navigate to the Neovim configuration directory and run:
cd ~/.config/nvim
make fetch-packs
make update-packs- Open Neovim with your new configuration
nvim- Explore the configuration files in ~/.config/nvim to understand how Neovim is set up.
Feel free to fork this repository and make contributions. For any issues or feature requests, please open an issue on the GitHub repository.
This configuration is licensed under the MIT License.
- Replace
https://github.com/your-username/your-repository.gitwith the URL of your own GitHub repository. - Update the plugin installation instructions according to the plugin manager you use (
vim-plug,packer.nvim, etc.). - Adjust the "Post-Installation" section based on the commands and tools you use.
This README.md provides a clear and comprehensive guide to installing and configuring Neovim with your custom setup.