diff --git a/README.md b/README.md index 4da7979..c4199f0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ # nvim +Using [NvChad](https://github.com/NvChad/NvChad) as a base. + +# Install pre-requisites +[Neovim](https://github.com/neovim/neovim/releases/tag/stable) + +[Nerd Font](https://www.nerdfonts.com/) as your terminal font. +⚠️ Make sure the nerd font you set doesn't end with Mono to prevent small icons. +Example: JetbrainsMono Nerd Font and not ~~JetbrainsMono Nerd Font Mono~~ + +[Ripgrep](https://github.com/BurntSushi/ripgrep) is required for grep searching with Telescope (OPTIONAL) + +# Clone NvChad +`git clone https://github.com/NvChad/starter ~/.config/nvim` + +# Run nvim +`nvim`