starter/README.md

💤 LazyVim

A starter template for LazyVim. Refer to the documentation to get started.

⚡️ Requirements

• Neovim >= 0.9.0 (needs to be built with LuaJIT)
• Git >= 2.19.0 (for partial clones support)
• a Nerd Font (v3.0 or greater) (optional, but needed to display some icons)
• lazygit (optional)
• a C compiler for nvim-treesitter. See here
• for telescope.nvim (optional)
  • live grep: ripgrep
  • find files: fd
• a terminal that support true color and undercurl:
  • kitty (Linux & Macos)
  • wezterm (Linux, Macos & Windows)
  • alacritty (Linux, Macos & Windows)
  • iterm2 (Macos)

🛠️ Installation

Linux/MacOS

Install the LazyVim

• Make a backup of your current Neovim files:

  # required
  mv ~/.config/nvim{,.bak}
  
  # optional but recommended
  mv ~/.local/share/nvim{,.bak}
  mv ~/.local/state/nvim{,.bak}
  mv ~/.cache/nvim{,.bak}
  

• Clone the LazyVim

  git clone https://github.com/13maximegorov/LazyVim ~/.config/nvim
  

• Remove the .git folder, so you can add it to your own repo later

  rm -rf ~/.config/nvim/.git
  

• Start Neovim!

  nvim
  

Windows

Install the LazyVim with PowerShell

• Make a backup of your current Neovim files:

  # required
  Move-Item $env:LOCALAPPDATA\nvim $env:LOCALAPPDATA\nvim.bak
  
  # optional but recommended
  Move-Item $env:LOCALAPPDATA\nvim-data $env:LOCALAPPDATA\nvim-data.bak
  

• Clone the LazyVim

  git clone https://github.com/13maximegorov/LazyVim $env:LOCALAPPDATA\nvim
  

• Remove the .git folder, so you can add it to your own repo later

  Remove-Item $env:LOCALAPPDATA\nvim\.git -Recurse -Force
  

• Start Neovim!

  nvim