From fbc0ca37132e1fed348b10820eafb972648236fd Mon Sep 17 00:00:00 2001 From: Bazaah Date: Fri, 30 Aug 2024 21:12:51 +0000 Subject: [PATCH] docs: update README for nvim changes --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 79a4d28..0aeb19c 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,14 @@ This is optimized by default for dark terminals, and contains configurations for use with - zsh >= v5.8 -- neovim >= v0.6 +- neovim >= v0.9 - tmux >= 3.2 All of these have standard setting but can be customized by using optional include files. Please read the following configs - `vimrc` +- `init.lua` - `zshrc` - `tmux/tmux.conf` @@ -48,8 +49,7 @@ them and then run the following commands. ( git pull --recurse-submodules=yes git submodule foreach git fetch --all --prune - git submodule foreach git checkout master - git submodule foreach git pull + git submodule update --remote --rebase git pull --recurse-submodules=yes ) @@ -85,7 +85,7 @@ git clone --recurse-submodules --recursive https://git.st8l.com/dolysis/psoxizsh ## Configure NeoVim -Make sure you have neovim (tested on v0.6.1) installed and after starting zsh +Make sure you have neovim (tested on v0.9.x, v0.10.x) installed and after starting zsh check that the following variable are set by typing You will need to install `neovim`, `nodejs` and `npm` to get the full use of vim @@ -93,10 +93,14 @@ You will need to install `neovim`, `nodejs` and `npm` to get the full use of vim Just start neovim (`nvim`) and wait for it to finish. After that quit and it should be ready to use. +You can also use: `nvim --headless '+Lazy! sync' +TSUpdate +qa` to sync all plugins +without opening neovim. + +See the default entrypoint ([init.lua](./init.lua)) for more details on how to +configure your local setup further. + ```bash -echo $VIMINIT -echo $MYVIMRC -echo $VIMHOME +nvim ~/.config/nvim/init.lua ``` Enjoy