diff --git a/README.md b/README.md new file mode 100644 index 0000000..b6bb79c --- /dev/null +++ b/README.md @@ -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`.