From a0d4284f53f90fb94430edb5309cee4bc0067e7e Mon Sep 17 00:00:00 2001 From: phajw Date: Thu, 25 Jan 2024 16:31:23 +0100 Subject: Add licence, enable silent formatters execution --- README.md | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 08b4293..77b2080 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,35 @@ -# My Neovim Config +# Overview + ![nvim](https://user-images.githubusercontent.com/91333841/212791030-440472c6-1568-4754-9181-c47e69bc42d6.png) -### Introduction +### Installation + Run checkhealth in your Neovim + ```vim :checkhealth ``` -Make sure you analyzed the output properly: -- Your neovim must be >= 0.7.0 to run this config + +Make sure you analyzed the output properly: + +- Your neovim must be >= 0.7.0 to run this config - You need to setup [Packer](https://github.com/wbthomason/packer.nvim) + ```vim git clone --depth 1 https://github.com/wbthomason/packer.nvim\ ~/.local/share/nvim/site/pack/packer/start/packer.nvim ``` -- You should install global python provider + +- You should install global python provider + ```python pip install pynvim ``` -- You should install clipboard tool (I use xclip but you can use something diffrent) + +- You should install clipboard tool (I use xclip but you can use something diffrent) ### Installation + > Easy way You can just clone this repo to your .config folder @@ -27,18 +37,21 @@ You can just clone this repo to your .config folder ```bash git clone https://github.com/dsrcr/nvim ~/.config ``` + > Recommended way I use gnu-stow to manage my dotfiles, so I encourage you to use it too. -Use your package manage of choice to get stow, for example: +Use your package manage of choice to get stow, for example: ```bash paru -S stow ``` + Clone this repo to your prefered dir and use stow to symlink In order to do this you need an empty nvim directory in your .config folder + ```bash cd ~/.config mkdir nvim @@ -53,14 +66,20 @@ The last step is running this command in your neovim ```vim :PackerSync ``` + This command should pull everything you need In the next step you will encounter a lot of errors, but don't worry about it. Packer needs to pull specific plugins and then you need to install Treesitter's support for specific filetypes eg. lua, rust.... etc. + ```bash :TSUpdate ``` + ```bash :TSInstall ``` +### Further development + +This is the only text editor on my system, so I'll be adding updates as long as I find something better(not gonna happen soon) -- cgit v1.2.3