summaryrefslogtreecommitdiff
path: root/README.md
blob: 8bdb7e6283da1ea64138b9d23ea3bb9a0c4cbb6f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# LazyVim

A starter template for [LazyVim](https://github.com/LazyVim/LazyVim)

## 🚀 Getting Started

This repo contains an example setup for
[LazyVim](https://github.com/LazyVim/LazyVim)

1. Make a backup of your current Neovim files:

   ```sh
   mv ~/.config/nvim ~/.config/nvim.bak
   mv ~/.local/share/nvim ~/.local/share/nvim.bak
   ```

2. Clone the starter

   ```sh
   git clone https://github.com/LazyVim/LazyVim ~/.config/nvim
   ```

3. Start Neovim!

   ```sh
   nvim
   ```

Refer to the comments in the files on how to customize **LazyVim**.

## File Structure

<pre>
~/.config/nvim
├── lua
│   ├── config
│   │   ├── autocmds.lua
│   │   ├── keymaps.lua
│   │   ├── lazy.lua
│   │   └── options.lua
│   └── plugins
│       └── example.lua
├── init.lua
└── stylua.toml
</pre>