From 052b17bc51ef7c147f1b7e4955b911ec91bbbc5d Mon Sep 17 00:00:00 2001 From: Folke Lemaitre Date: Wed, 11 Jan 2023 15:52:01 +0100 Subject: [PATCH] docs: simplified and add docker --- README.md | 84 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 52 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index e8f7f073..70425846 100644 --- a/README.md +++ b/README.md @@ -26,26 +26,44 @@ to tweak your config as needed, along with the convenience of a pre-configured s You can find a starter template for **LazyVim** [here](https://github.com/LazyVim/starter) -**TLDR:** +
Try it with Docker -```lua -require("lazy").setup({ - spec = { - -- import LazyVim plugins - { "LazyVim/LazyVim", import = "lazyvim.plugins" }, - -- import/override with your plugins - { import = "plugins" }, - -- import any extras modules here - -- { import = "lazyvim.plugins.extras.lang.typescript" }, - -- { import = "lazyvim.plugins.extras.lang.json" }, - }, - defaults = { - lazy = true, -- every plugin is lazy-loaded by default - version = "*", -- try installing the latest stable version for plugins that support semver - }, -}) +```sh +docker run -w /root -it --rm alpine:edge sh -uelic ' + apk add git lazygit neovim ripgrep alpine-sdk --update + git clone https://github.com/LazyVim/starter ~/.config/nvim + cd ~/.config/nvim + nvim +' ``` +
+ +
Install the LazyVim Starter + +- Make a backup of your current Neovim files: + + ```sh + mv ~/.config/nvim ~/.config/nvim.bak + mv ~/.local/share/nvim ~/.local/share/nvim.bak + ``` + +- Clone the starter + + ```sh + git clone https://github.com/LazyVim/starter ~/.config/nvim + ``` + +- Start Neovim! + + ```sh + nvim + ``` + + Refer to the comments in the files on how to customize **LazyVim**. + +
+ ## 📂 File Structure The files under config will be automatically loaded at the appropriate time, @@ -73,7 +91,22 @@ will be automatically loaded by [lazy.nvim](https://github.com/folke/lazy.nvim) ## ⚙️ Configuration -**LazyVim** comes with the following defaults: +**LazyVim** can be configured in the same way as any other plugin. + +For example in `lua/plugins/core.lua` + +```lua +return { + { + "LazyVim/LazyVim", + opts = { + colorscheme = "catppuccin", + } + } +} +``` + +
Default Settings @@ -139,20 +172,7 @@ will be automatically loaded by [lazy.nvim](https://github.com/folke/lazy.nvim) -**LazyVim** can be configured in the same way as any other plugin. - -For example in `lua/plugins/core.lua` - -```lua -return { - { - "LazyVim/LazyVim", - opts = { - colorscheme = "catppuccin", - } - } -} -``` +
## 🚀 Configuring **Plugins**