summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFolke Lemaitre <folke.lemaitre@gmail.com>2023-01-09 15:34:40 +0100
committerFolke Lemaitre <folke.lemaitre@gmail.com>2023-01-09 15:34:40 +0100
commited14d871ada87274616582e22f01b7ca961ec101 (patch)
tree1e3f5f0de484370eee9c68b0a1134e1d3b78fd0c
parent0dc68e0a21178dabe6dbe5030d847d041922016f (diff)
docs: added proper steps to install the starter
-rw-r--r--README.md20
1 files changed, 18 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9139e6e..8bdb7e6 100644
--- a/README.md
+++ b/README.md
@@ -7,8 +7,24 @@ A starter template for [LazyVim](https://github.com/LazyVim/LazyVim)
This repo contains an example setup for
[LazyVim](https://github.com/LazyVim/LazyVim)
-You can just clone this repo, or import **LazyVim** in your existing config
-as you can see here [config.lazy](https://github.com/LazyVim/starter/blob/main/lua/config/lazy.lua#L12)
+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**.