mirror of https://github.com/LazyVim/starter
94 lines
2.5 KiB
Markdown
94 lines
2.5 KiB
Markdown
# 💤 LazyVim
|
|
|
|
A starter template for [LazyVim](https://github.com/LazyVim/LazyVim).
|
|
Refer to the [documentation](https://lazyvim.github.io/installation) 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](https://www.nerdfonts.com/) (v3.0 or greater) **_(optional, but needed to display some icons)_**
|
|
- [lazygit](https://github.com/jesseduffield/lazygit) **_(optional)_**
|
|
- a **C** compiler for `nvim-treesitter`. See [here](https://github.com/nvim-treesitter/nvim-treesitter#requirements)
|
|
- for [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) **_(optional)_**
|
|
- **live grep**: [ripgrep](https://github.com/BurntSushi/ripgrep)
|
|
- **find files**: [fd](https://github.com/sharkdp/fd)
|
|
- a terminal that support true color and _undercurl_:
|
|
- [kitty](https://github.com/kovidgoyal/kitty) **_(Linux & Macos)_**
|
|
- [wezterm](https://github.com/wez/wezterm) **_(Linux, Macos & Windows)_**
|
|
- [alacritty](https://github.com/alacritty/alacritty) **_(Linux, Macos & Windows)_**
|
|
- [iterm2](https://iterm2.com/) **_(Macos)_**
|
|
|
|
## 🛠️ Installation
|
|
|
|
<details><summary>Linux/MacOS</summary>
|
|
|
|
Install the [LazyVim](https://github.com/13maximegorov/LazyVim)
|
|
|
|
- Make a backup of your current Neovim files:
|
|
|
|
```sh
|
|
# 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
|
|
|
|
```sh
|
|
git clone https://github.com/13maximegorov/LazyVim ~/.config/nvim
|
|
```
|
|
|
|
- Remove the `.git` folder, so you can add it to your own repo later
|
|
|
|
```sh
|
|
rm -rf ~/.config/nvim/.git
|
|
```
|
|
|
|
- Start Neovim!
|
|
|
|
```sh
|
|
nvim
|
|
```
|
|
|
|
</details>
|
|
|
|
<details><summary>Windows</summary>
|
|
|
|
Install the [LazyVim](https://github.com/13maximegorov/LazyVim)
|
|
with [PowerShell](https://github.com/PowerShell/PowerShell)
|
|
|
|
- Make a backup of your current Neovim files:
|
|
|
|
```powershell
|
|
# 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
|
|
|
|
```powershell
|
|
git clone https://github.com/13maximegorov/LazyVim $env:LOCALAPPDATA\nvim
|
|
```
|
|
|
|
- Remove the `.git` folder, so you can add it to your own repo later
|
|
|
|
```powershell
|
|
Remove-Item $env:LOCALAPPDATA\nvim\.git -Recurse -Force
|
|
```
|
|
|
|
- Start Neovim!
|
|
|
|
```powershell
|
|
nvim
|
|
```
|
|
|
|
</details>
|