From 83ea4bfcf312d66ac7885d24fa7bf0ed5ee06b5d Mon Sep 17 00:00:00 2001 From: Folke Lemaitre Date: Sun, 22 Jan 2023 15:44:25 +0100 Subject: docs: updated readme to point to the installation section of the docs --- README.md | 40 +--------------------------------------- 1 file changed, 1 insertion(+), 39 deletions(-) (limited to 'README.md') 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 - -
-~/.config/nvim
-├── lua
-│   ├── config
-│   │   ├── autocmds.lua
-│   │   ├── keymaps.lua
-│   │   ├── lazy.lua
-│   │   └── options.lua
-│   └── plugins
-│       └── example.lua
-├── init.lua
-└── stylua.toml
-
+Refer to the [installation](https://lazyvim.github.io/installation) documentation to get started. -- cgit v1.2.3