docs: update README for nvim changes

This commit is contained in:
Paul Stemmet 2024-08-30 21:12:51 +00:00
parent 80ed55f65d
commit fbc0ca3713
Signed by: Paul Stemmet
GPG Key ID: EDEA539F594E7E75
1 changed files with 11 additions and 7 deletions

View File

@ -10,13 +10,14 @@ This is optimized by default for dark terminals, and contains configurations for
use with use with
- zsh >= v5.8 - zsh >= v5.8
- neovim >= v0.6 - neovim >= v0.9
- tmux >= 3.2 - tmux >= 3.2
All of these have standard setting but can be customized by using optional All of these have standard setting but can be customized by using optional
include files. Please read the following configs include files. Please read the following configs
- `vimrc` - `vimrc`
- `init.lua`
- `zshrc` - `zshrc`
- `tmux/tmux.conf` - `tmux/tmux.conf`
@ -48,8 +49,7 @@ them and then run the following commands.
( (
git pull --recurse-submodules=yes git pull --recurse-submodules=yes
git submodule foreach git fetch --all --prune git submodule foreach git fetch --all --prune
git submodule foreach git checkout master git submodule update --remote --rebase
git submodule foreach git pull
git pull --recurse-submodules=yes git pull --recurse-submodules=yes
) )
@ -85,7 +85,7 @@ git clone --recurse-submodules --recursive https://git.st8l.com/dolysis/psoxizsh
## Configure NeoVim ## 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 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 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 Just start neovim (`nvim`) and wait for it to finish. After that quit and it
should be ready to use. 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 ```bash
echo $VIMINIT nvim ~/.config/nvim/init.lua
echo $MYVIMRC
echo $VIMHOME
``` ```
Enjoy Enjoy