From 1afbeca63f17e14611ca94bae66c5e3471142b37 Mon Sep 17 00:00:00 2001 From: TJ DeVries Date: Wed, 15 Feb 2023 15:34:45 -0500 Subject: [PATCH] docs --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4cc00b1..0c27017 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,17 @@ This repo is meant to be used as a starting point for a user's own configuration ### Installation * Backup your previous configuration -* Copy and paste the kickstart.nvim `init.lua` into `$HOME/.config/nvim/init.lua` (Linux) or `~/AppData/Local/nvim/init.lua` (Windows) +* Copy and paste the kickstart.nvim `init.lua` into `$HOME/.config/nvim/init.lua` (Linux/Mac) or `~/AppData/Local/nvim/init.lua` (Windows) * Start Neovim (`nvim`) and run `:PackerInstall` - ignore any error message about missing plugins, `:PackerInstall` will fix that shortly * Restart Neovim If there are languages that you don't want to use, remove their configuration and notes from your `init.lua` after copy and pasting (for example, in the mason configuration). +Additional requirements: +- Make sure to review the readmes of the plugins in the plugin list if anything is missing. In particular: + - [ripgrep](https://github.com/BurntSushi/ripgrep#installation) is required for multiple [telescope](https://github.com/nvim-telescope/telescope.nvim#suggested-dependencies) pickers. + ### Windows Installation Installation may require installing build tools, and updating the run command for `telescope-fzf-native`