]> git.localhorst.tv Git - nvim-config.git/commitdiff
docs: updated readme to point to the installation section of the docs
authorFolke Lemaitre <folke.lemaitre@gmail.com>
Sun, 22 Jan 2023 14:44:25 +0000 (15:44 +0100)
committerFolke Lemaitre <folke.lemaitre@gmail.com>
Sun, 22 Jan 2023 14:44:25 +0000 (15:44 +0100)
README.md
lua/config/lazy.lua

index 4a9c00dee21d1820fffff1c3de0890601782a321..f979c563bacbaba24ea5bd600454378183c7baf1 100644 (file)
--- 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.
index 61800967a4a53a99ed108dd7e32218fe150b8c7e..aabd65b82ebd605c7186a44dc2eb225d8ab2f213 100644 (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" },