]> git.localhorst.tv Git - nvim-config.git/commitdiff
docs: added proper steps to install the starter
authorFolke Lemaitre <folke.lemaitre@gmail.com>
Mon, 9 Jan 2023 14:34:40 +0000 (15:34 +0100)
committerFolke Lemaitre <folke.lemaitre@gmail.com>
Mon, 9 Jan 2023 14:34:40 +0000 (15:34 +0100)
README.md

index 9139e6e3ca00630df22666482153cf07d31f7ed6..8bdb7e6283da1ea64138b9d23ea3bb9a0c4cbb6f 100644 (file)
--- 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**.