https://github.com/gianbdev/nvim
nvim configs with git submodules
https://github.com/gianbdev/nvim
dotfiles nvim vim
Last synced: 3 months ago
JSON representation
nvim configs with git submodules
- Host: GitHub
- URL: https://github.com/gianbdev/nvim
- Owner: gianbdev
- Created: 2024-07-27T00:38:55.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T17:10:41.000Z (over 1 year ago)
- Last Synced: 2025-03-06T04:15:37.401Z (over 1 year ago)
- Topics: dotfiles, nvim, vim
- Language: Lua
- Homepage:
- Size: 3.97 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Neovim Configuration
This repository contains a custom Neovim configuration. Follow the instructions below to set up Neovim with this configuration.
## Installation
### Prerequisites
- **Neovim**: Ensure Neovim is installed on your system. You can follow the installation guide from the [Neovim official documentation](https://neovim.io/).
### Clone the Repository
1. Clone this repository into the Neovim configuration directory:
```bash
git clone https://github.com/your-username/your-repository.git ~/.config/nvim
```
2. If you already have a .config/nvim directory, you may want to back it up before cloning the new configuration
```bash
mv ~/.config/nvim ~/.config/nvim.bak
```
## Install Plugins
1. 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:
```bash
:PlugInstall
```
2. If you're using packer.nvim, run:
```bash
:PackerSync
```
## Post-Installation
* 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:
```bash
cd ~/.config/nvim
make fetch-packs
make update-packs
```
## Usage
* Open Neovim with your new configuration
```bash
nvim
```
* Explore the configuration files in ~/.config/nvim to understand how Neovim is set up.
### Contributing
Feel free to fork this repository and make contributions. For any issues or feature requests, please open an issue on the GitHub repository.
### License
This configuration is licensed under the MIT License.
### Notes:
- **Replace** `https://github.com/your-username/your-repository.git` with 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.