From 00a0c4d4598d1da67ab0267e306bc35fcf1be74b Mon Sep 17 00:00:00 2001
From: Folke Lemaitre <folke.lemaitre@gmail.com>
Date: Sat, 7 Jan 2023 11:29:44 +0100
Subject: [PATCH] docs: better docs for the starter template

---
 README.md | 103 ++++++++++--------------------------------------------
 1 file changed, 18 insertions(+), 85 deletions(-)

diff --git a/README.md b/README.md
index aaa9e3c..f01abd6 100644
--- a/README.md
+++ b/README.md
@@ -1,100 +1,33 @@
 # LazyVim
 
-A starter template for Neovim using [lazy.nvim](https://github.com/folke/lazy.nvim)
+A starter template for [LazyVim](https://github.com/LazyVim/LazyVim)
 
 ![image](https://user-images.githubusercontent.com/292349/210136312-c211f781-6d51-46b0-a265-6098bdbb364d.png)
 
-## ✅ Todo
+## 🚀 Getting Started
 
-- [ ] documentation
-- [x] treesitter auto-install seems broken. Switch to `ensure_installed` instead?
-- [x] list all plugins in readme
-- [ ] test all-the-things
+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)
+
+Refer to the comments in the files on how to customize **LazyVim**.
 
 ## File Structure
 
 <pre>
 ~/.config/nvim
 ├── lua
-│   └── lazyvim
-│       ├── config
-│       │   ├── autocmds.lua
-│       │   ├── keymaps.lua
-│       │   ├── lazy.lua
-│       │   ├── options.lua
-│       │   └── settings.lua
-│       ├── plugins
-│       │   ├── lsp
-│       │   │   ├── format.lua
-│       │   │   ├── init.lua
-│       │   │   ├── keymaps.lua
-│       │   │   └── servers.lua
-│       │   ├── coding.lua
-│       │   ├── colorscheme.lua
-│       │   ├── config.lua
-│       │   ├── editor.lua
-│       │   ├── treesitter.lua
-│       │   ├── ui.lua
-│       │   └── util.lua
-│       └── util.lua
+│   ├── config
+│   │   ├── autocmds.lua
+│   │   ├── keymaps.lua
+│   │   ├── lazy.lua
+│   │   └── options.lua
+│   └── plugins
+│       ├── example.lua
+│       ├── lsp.lua
+│       └── treesitter.lua
 ├── init.lua
-├── lazy-lock.json
-├── LICENSE
-├── README.md
 └── stylua.toml
 </pre>
-
-<!-- plugins:start -->
-
-## Plugins
-
-- [alpha-nvim](https://github.com/goolord/alpha-nvim)
-- [catppuccin](https://github.com/catppuccin/nvim)
-- [cmp-buffer](https://github.com/hrsh7th/cmp-buffer)
-- [cmp-emoji](https://github.com/hrsh7th/cmp-emoji)
-- [cmp-nvim-lsp](https://github.com/hrsh7th/cmp-nvim-lsp)
-- [cmp-path](https://github.com/hrsh7th/cmp-path)
-- [cmp_luasnip](https://github.com/saadparwaiz1/cmp_luasnip)
-- [dressing.nvim](https://github.com/stevearc/dressing.nvim)
-- [flit.nvim](https://github.com/ggandor/flit.nvim)
-- [friendly-snippets](https://github.com/rafamadriz/friendly-snippets)
-- [gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim)
-- [indent-blankline.nvim](https://github.com/lukas-reineke/indent-blankline.nvim)
-- [lazy.nvim](https://github.com/folke/lazy.nvim)
-- [leap.nvim](https://github.com/ggandor/leap.nvim)
-- [lualine.nvim](https://github.com/nvim-lualine/lualine.nvim)
-- [LuaSnip](https://github.com/L3MON4D3/LuaSnip)
-- [mason-lspconfig.nvim](https://github.com/williamboman/mason-lspconfig.nvim)
-- [mason.nvim](https://github.com/williamboman/mason.nvim)
-- [mini.ai](https://github.com/echasnovski/mini.ai)
-- [mini.bufremove](https://github.com/echasnovski/mini.bufremove)
-- [mini.comment](https://github.com/echasnovski/mini.comment)
-- [mini.indentscope](https://github.com/echasnovski/mini.indentscope)
-- [mini.pairs](https://github.com/echasnovski/mini.pairs)
-- [mini.surround](https://github.com/echasnovski/mini.surround)
-- [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim)
-- [neoconf.nvim](https://github.com/folke/neoconf.nvim)
-- [neodev.nvim](https://github.com/folke/neodev.nvim)
-- [noice.nvim](https://github.com/folke/noice.nvim)
-- [nui.nvim](https://github.com/MunifTanjim/nui.nvim)
-- [null-ls.nvim](https://github.com/jose-elias-alvarez/null-ls.nvim)
-- [nvim-bufferline.lua](https://github.com/akinsho/nvim-bufferline.lua)
-- [nvim-cmp](https://github.com/hrsh7th/nvim-cmp)
-- [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig)
-- [nvim-notify](https://github.com/rcarriga/nvim-notify)
-- [nvim-spectre](https://github.com/windwp/nvim-spectre)
-- [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter)
-- [nvim-treesitter-textobjects](https://github.com/nvim-treesitter/nvim-treesitter-textobjects)
-- [nvim-ts-context-commentstring](https://github.com/JoosepAlviste/nvim-ts-context-commentstring)
-- [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons)
-- [persistence.nvim](https://github.com/folke/persistence.nvim)
-- [plenary.nvim](https://github.com/nvim-lua/plenary.nvim)
-- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
-- [todo-comments.nvim](https://github.com/folke/todo-comments.nvim)
-- [tokyonight.nvim](https://github.com/folke/tokyonight.nvim)
-- [trouble.nvim](https://github.com/folke/trouble.nvim)
-- [vim-illuminate](https://github.com/RRethy/vim-illuminate)
-- [vim-startuptime](https://github.com/dstein64/vim-startuptime)
-- [which-key.nvim](https://github.com/folke/which-key.nvim)
-
-<!-- plugins:end -->
-- 
2.39.2