An nvim config from the gods for mere mortals

Introduction

This config is based on nvim-lua/kickstart.nvim, a basic init.lua great for the first time using neovim. And a fork of dam9000/kickstart-modular.nvim that makes kickstart.nvim modular.

A couple of additional plugins have been added:

• Oil (Directory editing)
• Harpoon (File hopping)
• Aerial (Symbol outline)
• LazyGit (GUI for git)

And a bunch of my own keymaps!

Installation

Install Neovim

Kickstart.nvim targets only the latest 'stable' of Neovim.

Install External Dependencies

External Requirements:

• Basic utils: git, make, unzip, C Compiler (gcc)

• ripgrep 'brew install ripgrep' for Telescope Live Grep

• A Nerd Font: optional, provides various icons

  • if you have it set vim.g.have_nerd_font in init.lua to true
  • FiraMono Nerd Font download

• LazyGit

NOTE See Windows Installation to double check any additional Windows notes

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

OS	PATH
Linux, MacOS	$XDG_CONFIG_HOME/nvim, ~/.config/nvim
Windows (cmd)	%userprofile%\AppData\Local\nvim\
Windows (powershell)	$env:USERPROFILE\AppData\Local\nvim\

Install this repo

Clone kickstart.nvim:

Linux and Mac

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

Windows

If you're using cmd.exe:

git clone https://github.com/kawanamelung/nvim %userprofile%\AppData\Local\nvim\

If you're using powershell.exe

git clone https://github.com/kawanamelung/nvim $env:USERPROFILE\AppData\Local\nvim\

Post Installation

Start Neovim

nvim

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

Read through the init.lua file in your configuration folder for more information about extending and exploring Neovim.

Getting Started

The Only Video You Need to Get Started with Neovim

FAQ

• What should I do if I already have a pre-existing neovim configuration?
  • You should back it up, then delete all files associated with it.
  • This includes your existing init.lua and the neovim files in ~/.local which can be deleted with rm -rf ~/.local/share/nvim/
• Can I keep my existing configuration in parallel to kickstart?
  • Yes! You can use NVIM_APPNAME=nvim-NAME to maintain multiple configurations. For example you can install the kickstart configuration in ~/.config/nvim-kickstart and create an alias:

    alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
    

    When you run Neovim using nvim-kickstart alias it will use the alternative config directory and the matching local directory ~/.local/share/nvim-kickstart. You can apply this approach to any Neovim distribution that you would like to try out.

Windows Installation

Installation may require installing build tools, and updating the run command for telescope-fzf-native

See telescope-fzf-native documentation for more details

This requires:

• Install CMake, and the Microsoft C++ Build Tools on Windows

{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }

Alternatively one can install gcc and make which don't require changing the config, the easiest way is to use choco:

1. install chocolatey either follow the instructions on the page or use winget, run in cmd as admin:

winget install --accept-source-agreements chocolatey.chocolatey

2. install all requirements using choco, exit previous cmd and open a new one so that choco path is set, run in cmd as admin:

choco install -y neovim git ripgrep wget fd unzip gzip mingw make

Then continue with the Install Kickstart step.