docs: add nvim setup guide
This commit is contained in:
parent
d757869b6f
commit
d84d890a1e
1 changed files with 49 additions and 0 deletions
49
README.md
Normal file
49
README.md
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
# Neovim config
|
||||
|
||||
This repo contains my Neovim configuration only.
|
||||
You still need Neovim installed on the machine.
|
||||
|
||||
## Quick start
|
||||
|
||||
```bash
|
||||
git clone https://git.sailorpunisher.com/sailor/nvim-config.git ~/nvim-config
|
||||
sh ~/nvim-config/install.sh
|
||||
nvim
|
||||
```
|
||||
|
||||
If `~/.config/nvim` already exists, `install.sh` will back it up and replace it.
|
||||
If it is already this repo, it will just update it with `git pull --ff-only`.
|
||||
|
||||
## Install Neovim
|
||||
|
||||
### Debian / Ubuntu
|
||||
|
||||
```bash
|
||||
sudo apt update
|
||||
sudo apt install -y git neovim
|
||||
```
|
||||
|
||||
### Arch Linux
|
||||
|
||||
```bash
|
||||
sudo pacman -S --needed git neovim
|
||||
```
|
||||
|
||||
### Gentoo
|
||||
|
||||
```bash
|
||||
sudo emerge --ask dev-vcs/git app-editors/neovim
|
||||
```
|
||||
|
||||
## Update later
|
||||
|
||||
Run this from the installed config directory:
|
||||
|
||||
```bash
|
||||
sh ~/.config/nvim/install.sh
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
- First run will download plugins through `lazy.nvim`.
|
||||
- The config lives in `~/.config/nvim`.
|
||||
Loading…
Reference in a new issue