kickstart.nvim/README.md

kickstart.nvim

Introduction

My semi-opinionated Neovim config.

Started from: original kickstart.nvim

Installation

Install Neovim

Kickstart.nvim targets only the latest 'stable' and latest 'nightly' of Neovim. If you are experiencing issues, please make sure you have the latest versions.

Install External Dependencies

External Requirements:

• Basic utils: git, make, unzip, C Compiler (gcc)
• ripgrep, fd-find
• Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
• A Nerd Font: optional, provides various icons
  • if you have it set vim.g.have_nerd_font in init.lua to true
• Emoji fonts (Ubuntu only, and only if you want emoji!) sudo apt install fonts-noto-color-emoji

Install Kickstart

Neovim's configurations are located under the following paths, depending on your OS:

OS	PATH
Linux, MacOS	$XDG_CONFIG_HOME/nvim, ~/.config/nvim

Recommended Step

Fork this repo so that you have your own copy that you can modify, then install by cloning the fork to your machine using one of the commands below, depending on your OS.

[!NOTE] Your fork's URL will be something like this: https://github.com/<your_github_username>/kickstart.nvim.git

You likely want to remove lazy-lock.json from your fork's .gitignore file too - it's ignored in the kickstart repo to make maintenance easier, but it's recommended to track it in version control.

Clone kickstart.nvim

[!NOTE] If following the recommended step above (i.e., forking the repo), replace nvim-lua with <your_github_username> in the commands below

Linux and Mac

git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim

Post Installation

Start Neovim

nvim

That's it! Lazy will install all the plugins you have. Use :Lazy to view the current plugin status. Hit q to close the window.