summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristian Chiarulli <[email protected]>2021-07-13 21:13:55 -0400
committerGitHub <[email protected]>2021-07-13 21:13:55 -0400
commita097fa4c04e6db34bb409e0dea302c20629da8ec (patch)
treefb1c5bdd14cac82a363ea6c25b03a475050305f2 /README.md
parent04f9f53914a7dd999117ed73c5fa0ab3b0dc95e4 (diff)
LunarVim 0.4.8 (#919)0.4.8
Diffstat (limited to 'README.md')
-rw-r--r--README.md81
1 files changed, 67 insertions, 14 deletions
diff --git a/README.md b/README.md
index eaf3c466..fd2cefc2 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,21 @@ Make sure you have the newest version of Neovim (0.5).
bash <(curl -s https://raw.githubusercontent.com/ChristianChiarulli/lunarvim/master/utils/installer/install.sh)
```
+If you help to develop Lunarvim, you can install a specific branch branch directly
+``` bash
+LVBRANCH=rolling bash <(curl -s https://raw.githubusercontent.com/ChristianChiarulli/lunarvim/rolling/utils/installer/install.sh)
+```
+
+If your installation is stuck on `Ok to remove? [y/N]`, it means there are some leftovers, \
+you can run the script with `--overwrite` but be warned this will remove the following folder:
+- `~/.config/nvim`
+- `~/.cache/nvim`
+- `~/.local/share/nvim/site/pack/packer`
+```bash
+curl -s https://raw.githubusercontent.com/ChristianChiarulli/lunarvim/rolling/utils/installer/install.sh| LVBRANCH=rolling bash -s -- --overwrite
+```
+
+
## Installing LSP for your language
Just enter `:LspInstall` followed by `<TAB>` to see your options
@@ -45,18 +60,16 @@ Example:
-- THESE ARE EXAMPLE CONFIGS FEEL FREE TO CHANGE TO WHATEVER YOU WANT
-- general
-O.auto_complete = true
-O.relative_number = false
+-- O.default_options.wrap = true -- wrap long lines
+O.completion.autocomplete = true
+O.default_options.relativenumber = true
O.colorscheme = 'spacegray'
-O.timeoutlen = 100
+O.default_options.timeoutlen = 100
O.leader_key = ' '
-- After changing plugin config it is recommended to run :PackerCompile
-O.plugin.colorizer.active = true
O.plugin.dashboard.active = true
O.plugin.floatterm.active = true
-O.plugin.symbol_outline = true
-O.plugin.trouble.active = true
O.plugin.zen.active = true
-- if you don't want all the parsers change this to a table of the ones you want
@@ -74,18 +87,29 @@ O.lang.tsserver.linter = nil
O.lang.tsserver.autoformat = true
-- python
--- O.python.linter = 'flake8'
O.lang.python.isort = true
O.lang.python.diagnostics.virtual_text = true
O.lang.python.analysis.use_library_code_types = true
+-- to change default formatter from yapf to black
+-- O.lang.python.formatter.exe = "black"
+-- O.lang.python.formatter.args = {"-"}
+
+-- go
+-- to change default formatter from gofmt to goimports
+-- O.lang.formatter.go.exe = "goimports"
-- Additional Plugins
-- O.user_plugins = {
--- {"folke/tokyonight.nvim"}, {
--- "ray-x/lsp_signature.nvim",
--- config = function() require"lsp_signature".on_attach() end,
--- event = "InsertEnter"
--- }
+-- {"folke/tokyonight.nvim"},
+-- {
+-- "ray-x/lsp_signature.nvim",
+-- config = function()
+-- require"lsp_signature".on_attach()
+-- end,
+-- event = "InsertEnter"
+-- },
+-- }
+
-- }
-- Autocommands (https://neovim.io/doc/user/autocmd.html)
@@ -99,6 +123,9 @@ O.lang.python.analysis.use_library_code_types = true
-- b = { "<cmd>echo 'second custom command'<cr>", "Description for b" },
-- },
-- }
+
+-- To link your init.vim (until you find Lua replacements)
+-- vim.cmd('source ' .. CONFIG_PATH .. '/lua/lv-user/init.vim')
```
## Updating LunarVim
@@ -119,6 +146,29 @@ cd ~/.config/nvim && git pull
To update Neovim use your package manager
+## Project Goals
+
+1. Provide basic functionalities required from an IDE
+ - LSP
+ - Formatting/Linting
+ - Debugging
+ - Treesitter
+ - Colorschemes
+2. Be as fast and lean as possible
+ - Lazy loading
+ - Not a single extra plugin
+ - User configurable lang/feature enable/disable
+3. Provide a [simple and easy](https://github.com/LunarVim/LunarVimCommunity) way for users to share their own configuration or use others.
+4. Hot reload of configurations
+ - Hot install of lsp/treesitter/formatter required upon openning a filetype for the first time
+5. Provide a stable & maintainable error free configuration layer over neovim
+ - With the help of the community behind it
+ - Github workflow testing
+ - Freezing plugin versions
+6. Provide detailed documentation
+ - Video series on how to configure LunarVim as an IDE for each lang
+7. Valhalla
+
## Resources
- [YouTube](https://www.youtube.com/channel/UCS97tchJDq17Qms3cux8wcA)
@@ -134,8 +184,11 @@ To update Neovim use your package manager
> "I have the processing power of a potato with 4 gb of ram and LunarVim runs perfectly."
> - @juanCortelezzi, LunarVim user.
-<div align="center">
+> "My minimal config with a good amount less code than LunarVim loads 40ms slower. Time to switch."
+> - @mvllow, Potential LunarVim user.
+
+<div align="center" id="madewithlua">
-[![Lua](https://img.shields.io/badge/Made%20with%20Lua-blue.svg?style=for-the-badge&logo=lua)]()
+[![Lua](https://img.shields.io/badge/Made%20with%20Lua-blue.svg?style=for-the-badge&logo=lua)](#madewithlua)
</div>