5.9 KiB
nvim-config
Introduction
This is a fork of dam9000/kickstart-modular.nvim that represents my personal configuration of Neovim.
Installation
Install Neovim
Kickstart.nvim targets only the latest 'stable' and latest 'nightly' of Neovim. If you are experiencing issues, please make sure you have the latest versions.
Install External Dependencies
NOTE Backup your previous configuration (if any exists)
External Requirements:
- Basic utils:
git
,make
,unzip
, C Compiler (gcc
) - ripgrep
- A Nerd Font: provides various icons
- Language utils:
rustup
,npm
,dotnet
,python
- Optionally, install Alacritty
- Or on Windows, just install using
winget install alacritty --source winget
- Or on Windows, just install using
NOTE See Install Recipes for additional Windows and Linux specific notes and quick install snippets
Neovim's configurations are located under the following paths, depending on your OS:
OS | PATH |
---|---|
Linux, MacOS | $XDG_CONFIG_HOME/nvim , ~/.config/nvim |
Windows (cmd) | %userprofile%\AppData\Local\nvim\ |
Windows (powershell) | $env:USERPROFILE\AppData\Local\nvim\ |
Install this Configuration
Clone it from GitHub:
Linux and Mac
git clone https://github.com/Baipyrus/nvim-config.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
Windows
If you're using cmd.exe
:
git clone https://github.com/Baipyrus/nvim-config.git %userprofile%\AppData\Local\nvim\
If you're using powershell.exe
git clone https://github.com/Baipyrus/nvim-config.git $env:USERPROFILE\AppData\Local\nvim\
Post Installation
Extras for Linux and Mac
In the [`options`](./lua/options.lua) file, change the settings to specify the terminal of your choice. This installation is used and maintained by a Windows user and, as such, will use Powershell. This setting may need to be updated after each upgrade.Start Neovim
nvim
That's it! Lazy will install all the plugins you have. Use :Lazy
to view
current plugin status.
FAQ
- What should I do if I already have a pre-existing neovim configuration?
- You should back it up and then delete all associated files.
- This includes your existing init.lua and the neovim files in
~/.local
which can be deleted withrm -rf ~/.local/share/nvim/
or their windows counterparts inAppData\Local\nvim-data
- Can I keep my existing configuration in parallel to kickstart?
- Yes! You can use NVIM_APPNAME
=nvim-NAME
to maintain multiple configurations. For example, you can install the kickstart configuration in~/.config/nvim-kickstart
and create an alias:
When you run Neovim usingalias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
nvim-kickstart
alias it will use the alternative config directory and the matching local directory~/.local/share/nvim-kickstart
. You could also run your configuration inline, for example in Windows Powershell:$env:NVIM_APPNAME = 'nvim-kickstart'; nvim
- Yes! You can use NVIM_APPNAME
- What if I want to "uninstall" this configuration:
- See lazy.nvim uninstall information
Install Recipes
Below you can find OS specific install instructions for Neovim and dependencies.
After installing all the dependencies continue with the Install Kickstart step.
Windows Installation
Windows with Microsoft C++ Build Tools and CMake
Installation may require installing build tools and updating the run command for `telescope-fzf-native`See telescope-fzf-native
documentation for more details
This requires:
- Install CMake and the Microsoft C++ Build Tools on Windows
Using this, you can change some plugin configurations such as telescope-fzf-native
to use cmake
:
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
Windows with gcc/make using chocolatey
Alternatively, one can install gcc and make which don't require changing the config, the easiest way is to use choco:- install chocolatey either follow the instructions on the page or use winget, run in cmd as admin:
winget install --accept-source-agreements chocolatey.chocolatey
- install all requirements using choco, exit previous cmd and open a new one so that choco path is set, and run in cmd as admin:
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
WSL (Windows Subsystem for Linux)
wsl --install
wsl
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip neovim
Linux Install
Ubuntu Install Steps
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip neovim
Debian Install Steps
sudo apt update
sudo apt install make gcc ripgrep unzip git
echo "deb https://deb.debian.org/debian unstable main" | sudo tee -a /etc/apt/sources.list
sudo apt update
sudo apt install -t unstable neovim
Fedora Install Steps
sudo dnf install -y gcc make git ripgrep fd-find neovim