docs: updated readme to point to the installation section of the docs

This commit is contained in:
Folke Lemaitre 2023-01-22 15:44:25 +01:00
parent e1f0f3443d
commit 83ea4bfcf3
No known key found for this signature in database
GPG Key ID: 41F8B1FBACAE2040
2 changed files with 2 additions and 40 deletions

View File

@ -4,42 +4,4 @@ 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/starter ~/.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>
Refer to the [installation](https://lazyvim.github.io/installation) documentation to get started.

View File

@ -8,7 +8,7 @@ vim.opt.rtp:prepend(vim.env.LAZY or lazypath)
require("lazy").setup({
spec = {
-- import LazyVim plugins
-- add LazyVim and import its plugins
{ "LazyVim/LazyVim", import = "lazyvim.plugins" },
-- import/override with your plugins
{ import = "plugins" },