From ac8dc56fc44d5b77e1af286f131103ecbaf7e418 Mon Sep 17 00:00:00 2001 From: Steins7 Date: Thu, 20 Oct 2022 15:14:43 +0200 Subject: [PATCH] Fix README --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 732bd81..64297fe 100644 --- a/README.md +++ b/README.md @@ -17,23 +17,26 @@ This will create a new nvim folder in your .config folder, containing all the co git clone https://github.com/Steins7/nvim ~/.config/nvim ``` -And that's it for the configuration part. Once nvim is started, run `:PloginsUpgrade` wich will fetch all the necessary plugins, store them in `~/.local/nvim` and load them each time you start the editor. At this point, you are ready to install the external depencies needed for all those plugins to work properly. +And that's it for the configuration part. Once nvim is started, the necessary plugins will be automatically fetched and stored `~/.local/nvim`. At this point, you are ready to install the external depencies needed for all those plugins to work properly. ### External depencies Here is a list of all external depencies you'll need: -- python 3 (3.8 minimum) -- python-venv (shipped in python > 3.3) -- universal ctags, ctags won't work (note that arch's universal ctags package is named ctags...) -- rust-analyzer +- universal ctags, ctags won't work (note that arch's universal ctags package is named ctags...), for tagbar +- tree-sitter, for syntax coloration +- rust-analyzer, as LSP server On arch, you can just use the following command : ``` -pacman -Syu python ctags rust-analyzer +pacman -Syu ctags tree-sitter rust-analyzer ``` -Once the dependencies are installed, COQ may prompt you to execute `COQdeps` and update the dependencies which you should do. Atfter that, either restart nvim or execute `COQnow`. +Once the dependencies are installed, type `:checkhealth` to verify that everything is properly detected. You should, at most, see a warning about node and another about the clipboard. + +### Syntax coloration + +By default, this config only supports C/C++, Lua and Rust. You can add more default languages in lua/plugins.lua or add them on the fly by typing `:TSInstall ` Tinkering ---------