changed README.md

pull/82/head
Maxim Egorov 2024-04-25 13:49:20 +05:00
parent be84eb5e6c
commit 9483d8485b
1 changed files with 52 additions and 0 deletions

View File

@ -2,3 +2,55 @@
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>
- 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>