summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFolke Lemaitre <folke.lemaitre@gmail.com>2023-01-22 15:44:25 +0100
committerFolke Lemaitre <folke.lemaitre@gmail.com>2023-01-22 15:44:25 +0100
commit83ea4bfcf312d66ac7885d24fa7bf0ed5ee06b5d (patch)
tree6a26699e07376a54a46b7bab71c38d3cb7741bbd /README.md
parente1f0f3443d2e44ded226b5188bd8ece708ee8fba (diff)
docs: updated readme to point to the installation section of the docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 1 insertions, 39 deletions
diff --git a/README.md b/README.md
index 4a9c00d..f979c56 100644
--- a/README.md
+++ b/README.md
@@ -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.