diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 184 |
1 files changed, 41 insertions, 143 deletions
@@ -2,169 +2,67 @@ <div align="center"><p> <a href="https://github.com/lunarvim/LunarVim/releases/latest"> - <img alt="Latest release" src="https://img.shields.io/github/v/release/lunarvim/LunarVim" /> + <img alt="Latest release" src="https://img.shields.io/github/v/release/LunarVim/LunarVim?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41" /> </a> <a href="https://github.com/lunarvim/LunarVim/pulse"> - <img alt="Last commit" src="https://img.shields.io/github/last-commit/lunarvim/LunarVim"/> + <img alt="Last commit" src="https://img.shields.io/github/last-commit/lunarvim/LunarVim?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41"/> </a> <a href="https://github.com/lunarvim/LunarVim/blob/main/LICENSE"> - <img src="https://img.shields.io/github/license/lunarvim/lunarvim?style=flat-square&logo=GNU&label=License" alt="License" - /> + <img alt="License" src="https://img.shields.io/github/license/lunarvim/lunarvim?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41" /> + </a> + <a href="https://github.com/LunarVim/LunarVim/stargazers"> + <img alt="Stars" src="https://img.shields.io/github/stars/LunarVim/LunarVim?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41" /> + </a> + <a href="https://github.com/LunarVim/LunarVim/issues"> + <img alt="Issues" src="https://img.shields.io/github/issues/LunarVim/LunarVim?style=for-the-badge&logo=bilibili&color=F5E0DC&logoColor=D9E0EE&labelColor=302D41" /> + </a> + <a href="https://github.com/LunarVim/LunarVim"> + <img alt="Repo Size" src="https://img.shields.io/github/repo-size/LunarVim/LunarVim?color=%23DDB6F2&label=SIZE&logo=codesandbox&style=for-the-badge&logoColor=D9E0EE&labelColor=302D41" /> + </a> <a href="https://patreon.com/chrisatmachine" title="Donate to this project using Patreon"> - <img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /> + <img alt="Patreon donate button" src="https://img.shields.io/badge/patreon-donate-yellow.svg?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41" /> </a> <a href="https://twitter.com/intent/follow?screen_name=chrisatmachine"> - <img src="https://img.shields.io/twitter/follow/chrisatmachine?style=social&logo=twitter" alt="follow on Twitter"> + <img alt="follow on Twitter" src="https://img.shields.io/twitter/follow/chrisatmachine?style=for-the-badge&logo=twitter&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41" /> </a> -</p> - -</div> - -## Showcase - - - - - - - -## Install In One Command! - -Make sure you have the release version of Neovim (0.8+). - -### Linux/MacOS: - -If you are running Neovim 0.8+ - -```bash -bash <(curl -s https://raw.githubusercontent.com/lunarvim/lunarvim/master/utils/installer/install.sh) -``` - -If you are running Neovim 0.8+ - -```bash -export LV_BRANCH="rolling"; bash <(curl -s https://raw.githubusercontent.com/lunarvim/lunarvim/rolling/utils/installer/install.sh) -``` - -To run the install script without any interaction you can pass the `-y` flag to automatically install all dependencies and have no prompts. This is particularly useful in automated installations. - -In the same way, you can use `--no-install-dependencies` to skip the dependency installation. - -### Windows (Powershell 7+): -Powershell v7+ is required for this script. For instructions on how to install, [click here.](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2) + <p align="center"> + <img src="https://stars.medv.io/LunarVim/LunarVim.svg", title="commits"/> + </p> -```powershell -Invoke-WebRequest https://raw.githubusercontent.com/LunarVim/LunarVim/master/utils/installer/install.ps1 -UseBasicParsing | Invoke-Expression -``` +An IDE layer for Neovim with sane defaults. Completely free and community driven. -## Automatic LSP support +--- -By default, most supported language servers will get automatically installed once you open the supported file type, e.g, opening a Python file for the first time will install `Pyright` and configure it automatically for you. +**[<kbd> <br> Install <br> </kbd>][Install]**  +**[<kbd> <br> Configure <br> </kbd>][Configure]**  +**[<kbd> <br> Troubleshooting <br> </kbd>][Troubleshoot]**  +**[<kbd> <br> Contribute <br> </kbd>][Contribute]** -## Configuration file +--- -To install plugins configure LunarVim use the `config.lua` located here: `~/.config/lvim/config.lua` - -Example: - -```lua --- general -lvim.format_on_save = true -lvim.colorscheme = "tokyonight" - -lvim.leader = "space" --- add your own keymapping -lvim.keys.normal_mode["<C-s>"] = ":w<cr>" --- unmap a default keymapping --- lvim.keys.normal_mode["<C-Up>"] = "" --- edit a default keymapping --- lvim.keys.normal_mode["<C-q>"] = ":q<cr>" --- set keymap with custom opts --- lvim.keys.insert_mode["po"] = {'<ESC>', { noremap = true }} - --- Use which-key to add extra bindings with the leader-key prefix --- lvim.builtin.which_key.mappings["P"] = { "<cmd>Telescope projects<CR>", "Projects" } - --- Configure builtin plugins -lvim.builtin.alpha.active = true -lvim.builtin.notify.active = true -lvim.builtin.terminal.active = true - --- Treesitter parsers change this to a table of the languages you want i.e. {"java", "python", javascript} -lvim.builtin.treesitter.ensure_installed = "all" -lvim.builtin.treesitter.ignore_install = { "haskell" } - --- Disable virtual text -lvim.lsp.diagnostics.virtual_text = false - --- Select which servers should be configured manually. Requires `:LvimCacheReset` to take effect. --- See the full default list `:lua print(vim.inspect(lvim.lsp.override))` -vim.list_extend(lvim.lsp.automatic_configuration.skipped_servers, { "pyright" }) - --- set a formatter, this will override the language server formatting capabilities (if it exists) -local formatters = require "lvim.lsp.null-ls.formatters" -formatters.setup { - { command = "black" }, - { - command = "prettier", - ---@usage specify which filetypes to enable. By default, providers will attach to all the filetypes it supports. - filetypes = { "typescript", "typescriptreact" }, - }, -} - --- set additional linters -local linters = require "lvim.lsp.null-ls.linters" -linters.setup { - { - command = "eslint_d", - ---@usage specify which filetypes to enable. By default, providers will attach to all the filetypes it supports. - filetypes = { "javascript", "javascriptreact" }, - }, -} - --- Additional Plugins -lvim.plugins = { - {"lunarvim/colorschemes"}, - { - "ray-x/lsp_signature.nvim", - config = function() require"lsp_signature".on_attach() end, - event = "BufRead" - } -} -``` - -## Updating LunarVim - -- inside LunarVim `:LvimUpdate` -- from the command-line `lvim +LvimUpdate +q` - -### Update the plugins - -- inside LunarVim `:PackerUpdate` - -## Resources - -- [Documentation](https://www.lunarvim.org) - -- [YouTube](https://www.youtube.com/channel/UCS97tchJDq17Qms3cux8wcA) +## Showcase -- [Discord](https://discord.gg/Xb9B4Ny) + + -- [Twitter](https://twitter.com/chrisatmachine) +<!-----------------------------------------------------------------------------> -## Testimonials +## Socials -> "I have the processing power of a potato with 4 gb of ram and LunarVim runs perfectly." -> -> - @juanCortelezzi, LunarVim user. +<p align="center"> +<a href="https://github.com/Lunarvim"><img src="https://user-images.githubusercontent.com/696094/196835284-c52d4bd1-7034-439e-848b-47d4f2933dff.svg" width="64" height="64" alt="Github Logo"/></a> <img src="assets/misc/transparent.png" height="1" width="5"/> <a href="https://discord.gg/Xb9B4Ny"><img src="https://user-images.githubusercontent.com/696094/196835282-f5c47d66-29b7-4210-9ee0-d9cdecde3559.svg" width="64" height="64" alt="Discord Logo"/></a> <img src="assets/misc/transparent.png" height="1" width="5"/> <a href="https://twitter.com/chrisatmachine"><img src="https://user-images.githubusercontent.com/696094/196835281-52617611-ede6-40da-a4bc-8c5025622bbf.svg" width="64" height="64" alt="Twitter Logo"/></a> <img src="assets/misc/transparent.png" height="1" width="5"/> <a href="https://reddit.com/r/Lunarvim"><img src="https://user-images.githubusercontent.com/696094/196835278-041a4f99-28e1-4a93-8e35-c8912f1089fc.svg" width="64" height="64" alt="Reddit Logo"/></a> +</p> -> "My minimal config with a good amount less code than LunarVim loads 40ms slower. Time to switch." -> -> - @mvllow, Potential LunarVim user. +[Contribute]: https://github.com/LunarVim/LunarVim/blob/master/CONTRIBUTING.md +[Install]: https://www.lunarvim.org/docs/installation +[Troubleshoot]: https://www.lunarvim.org/docs/troubleshooting +[Configure]: https://www.lunarvim.org/docs/configuration -<div align="center" id="madewithlua"> +## Thanks to all contributors -[](#madewithlua) +<a href="https://github.com/Lunarvim/Lunarvim/graphs/contributors"> + <img src="https://contrib.rocks/image?repo=Lunarvim/Lunarvim" /> +</a> </div> |