2021-06-30 06:55:40 +02:00
|
|
|
![LunarVim Demo](./utils/media/lunarvim_logo_dark.png)
|
2021-05-04 23:55:45 +02:00
|
|
|
|
2021-06-30 20:28:26 +02:00
|
|
|
<div align="center"><p>
|
2021-08-04 21:20:09 +02:00
|
|
|
<a href="https://github.com/lunarvim/LunarVim/releases/latest">
|
|
|
|
<img alt="Latest release" src="https://img.shields.io/github/v/release/lunarvim/LunarVim" />
|
2021-06-30 20:28:26 +02:00
|
|
|
</a>
|
2021-08-04 21:20:09 +02:00
|
|
|
<a href="https://github.com/lunarvim/LunarVim/pulse">
|
|
|
|
<img alt="Last commit" src="https://img.shields.io/github/last-commit/lunarvim/LunarVim"/>
|
2021-06-30 20:28:26 +02:00
|
|
|
</a>
|
2021-08-04 21:20:09 +02:00
|
|
|
<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"
|
2021-07-06 16:02:40 +02:00
|
|
|
/>
|
2021-06-30 20:28:26 +02:00
|
|
|
<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" />
|
|
|
|
</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">
|
|
|
|
</a>
|
2021-07-06 16:02:40 +02:00
|
|
|
</p>
|
|
|
|
|
2021-06-30 20:28:26 +02:00
|
|
|
</div>
|
2021-03-27 19:32:45 +01:00
|
|
|
|
2021-09-02 17:22:51 +02:00
|
|
|
## Documentation
|
2021-05-04 23:55:45 +02:00
|
|
|
|
2021-09-02 17:22:51 +02:00
|
|
|
You can find all of the documentation for Lunarvim at [lunarvim.org](https://www.lunarvim.org)
|
2021-08-23 17:18:42 +02:00
|
|
|
|
2021-09-02 17:22:51 +02:00
|
|
|
## Install In One Command!
|
2021-08-23 17:18:42 +02:00
|
|
|
|
2021-09-02 17:22:51 +02:00
|
|
|
Make sure you have the release version of Neovim (0.5).
|
2021-08-23 17:18:42 +02:00
|
|
|
|
2021-09-14 12:53:17 +02:00
|
|
|
If you have previously installed LunarVim, make sure to remove `/usr/local/bin/lvim`, as we've moved the launcher to `~/.local/bin/lvim`
|
2021-09-14 09:33:10 +02:00
|
|
|
|
2021-07-11 01:25:35 +02:00
|
|
|
``` bash
|
2021-09-02 17:22:51 +02:00
|
|
|
bash <(curl -s https://raw.githubusercontent.com/lunarvim/lunarvim/master/utils/installer/install.sh)
|
2021-07-13 17:27:38 +02:00
|
|
|
```
|
|
|
|
|
2021-09-02 17:22:51 +02:00
|
|
|
## Install Language support
|
2021-07-11 01:25:35 +02:00
|
|
|
|
2021-09-02 17:22:51 +02:00
|
|
|
- Enter `:LspInstall` followed by `<TAB>` to see your options for LSP
|
2021-04-29 07:36:13 +02:00
|
|
|
|
2021-09-02 17:22:51 +02:00
|
|
|
- Enter `:TSInstall` followed by `<TAB>` to see your options for syntax highlighting
|
2021-05-04 23:55:45 +02:00
|
|
|
|
2021-07-31 20:28:59 +02:00
|
|
|
**NOTE** I recommend installing `lua` for autocomplete in `config.lua`
|
2021-04-29 07:36:13 +02:00
|
|
|
|
2021-07-03 02:58:53 +02:00
|
|
|
## Configuration file
|
2021-04-29 07:36:13 +02:00
|
|
|
|
2021-09-02 17:28:16 +02:00
|
|
|
To install plugins configure LunarVim use the `config.lua` located here: `~/.config/lvim/config.lua`
|
2021-04-29 07:36:13 +02:00
|
|
|
|
|
|
|
Example:
|
2021-05-04 23:55:45 +02:00
|
|
|
|
2021-06-26 20:22:50 +02:00
|
|
|
```lua
|
2021-07-03 02:58:53 +02:00
|
|
|
-- general
|
2021-07-25 06:42:38 +02:00
|
|
|
lvim.format_on_save = true
|
2021-08-30 07:00:58 +02:00
|
|
|
lvim.colorscheme = "onedarker"
|
2021-07-18 19:49:41 +02:00
|
|
|
|
2021-07-25 06:42:38 +02:00
|
|
|
lvim.leader = "space"
|
2021-08-02 23:42:56 +02:00
|
|
|
-- 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>"
|
2021-08-03 07:04:51 +02:00
|
|
|
-- set keymap with custom opts
|
|
|
|
-- lvim.keys.insert_mode["po"] = {'<ESC>', { noremap = true }}
|
2021-08-02 23:42:56 +02:00
|
|
|
|
|
|
|
-- Use which-key to add extra bindings with the leader-key prefix
|
2021-08-23 05:50:36 +02:00
|
|
|
-- lvim.builtin.which_key.mappings["P"] = { "<cmd>Telescope projects<CR>", "Projects" }
|
2021-07-25 06:42:38 +02:00
|
|
|
|
2021-09-02 17:28:16 +02:00
|
|
|
-- Configure builtin plugins
|
2021-07-25 06:42:38 +02:00
|
|
|
lvim.builtin.dashboard.active = true
|
|
|
|
lvim.builtin.terminal.active = true
|
2021-06-26 20:22:50 +02:00
|
|
|
|
2021-09-02 17:28:16 +02:00
|
|
|
-- Treesitter parsers change this to a table of the languages you want i.e. {"java", "python", javascript}
|
2021-07-25 06:42:38 +02:00
|
|
|
lvim.builtin.treesitter.ensure_installed = "maintained"
|
|
|
|
lvim.builtin.treesitter.ignore_install = { "haskell" }
|
|
|
|
|
2021-09-02 17:28:16 +02:00
|
|
|
-- Disable virtual text
|
2021-07-25 06:42:38 +02:00
|
|
|
lvim.lsp.diagnostics.virtual_text = false
|
2021-07-07 08:36:56 +02:00
|
|
|
|
2021-07-31 06:06:08 +02:00
|
|
|
-- set a formatter if you want to override the default lsp one (if it exists)
|
|
|
|
lvim.lang.python.formatters = {
|
|
|
|
{
|
|
|
|
exe = "black",
|
|
|
|
args = {}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
-- set an additional linter
|
|
|
|
lvim.lang.python.linters = {
|
|
|
|
{
|
|
|
|
exe = "flake8",
|
|
|
|
args = {}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2021-07-07 08:36:56 +02:00
|
|
|
-- Additional Plugins
|
2021-07-25 06:42:38 +02:00
|
|
|
lvim.plugins = {
|
|
|
|
{"lunarvim/colorschemes"},
|
|
|
|
{"folke/tokyonight.nvim"}, {
|
|
|
|
"ray-x/lsp_signature.nvim",
|
|
|
|
config = function() require"lsp_signature".on_attach() end,
|
|
|
|
event = "InsertEnter"
|
|
|
|
}
|
|
|
|
}
|
2021-07-18 19:57:05 +02:00
|
|
|
```
|
|
|
|
|
2021-07-03 02:58:53 +02:00
|
|
|
## Updating LunarVim
|
2021-03-26 22:02:27 +01:00
|
|
|
|
2021-07-03 02:58:53 +02:00
|
|
|
In order to update you should be aware of three things `Plugins`, `LunarVim` and `Neovim`
|
2021-03-26 05:58:18 +01:00
|
|
|
|
2021-07-03 02:58:53 +02:00
|
|
|
To update plugins:
|
2021-05-04 23:55:45 +02:00
|
|
|
|
2021-05-03 02:13:09 +02:00
|
|
|
```
|
2021-07-03 02:58:53 +02:00
|
|
|
:PackerUpdate
|
2021-05-03 02:13:09 +02:00
|
|
|
```
|
2021-03-23 03:09:11 +01:00
|
|
|
|
2021-07-03 02:58:53 +02:00
|
|
|
To update LunarVim:
|
2021-05-03 02:13:09 +02:00
|
|
|
|
2021-07-08 07:36:44 +02:00
|
|
|
```bash
|
2021-07-21 09:09:37 +02:00
|
|
|
cd ~/.local/share/lunarvim/lvim && git pull
|
2021-07-20 12:12:51 +02:00
|
|
|
:PackerSync
|
2021-09-14 14:37:09 +02:00
|
|
|
```
|
|
|
|
## Known Issues
|
|
|
|
If you get either of the following errors
|
|
|
|
- init.lua:6: module 'bootstrap' not found:
|
|
|
|
- /home/user/.config/nvim/config.lua not found, falling back to /home/user/.config/nvim/lv-config.lua
|
|
|
|
|
|
|
|
Try the following:
|
|
|
|
```bash
|
|
|
|
which lvim
|
|
|
|
# if output is /usr/local/bin/lvim remove it
|
|
|
|
sudo rm /usr/local/bin/lvim
|
|
|
|
|
|
|
|
which lvim
|
|
|
|
# if output is ~/.local/bin/lvim, open lvim and run :PackerSync. That should get you to a working state
|
|
|
|
|
|
|
|
# otherwise if `which lvim` returns `not found`,
|
|
|
|
Make sure the `lvim` file exists in `~/.local/bin/lvim`.
|
|
|
|
If the file exists,make sure `~/.local/bin` is in your PATH. If not, [add it](https://www.lunarvim.org/02-after-install.html#add-lvim-to-path)
|
|
|
|
either reinstall again or manually add the lunarvim launcher
|
|
|
|
|
|
|
|
If the file doesn't exist, create the file
|
|
|
|
cd ~/.local/bin
|
|
|
|
touch lvim
|
|
|
|
chmod 755 lvim
|
|
|
|
```
|
|
|
|
|
|
|
|
And then add the following to the lvim file you created. Replace all `torvalds` with your user name
|
|
|
|
|
|
|
|
```bash
|
|
|
|
#!/bin/sh
|
|
|
|
|
|
|
|
export LUNARVIM_CONFIG_DIR="${LUNARVIM_CONFIG_DIR:-/home/torvalds/.config/lvim}"
|
|
|
|
export LUNARVIM_RUNTIME_DIR="${LUNARVIM_RUNTIME_DIR:-/home/torvalds/.local/share/lunarvim}"
|
|
|
|
|
|
|
|
exec nvim -u "$LUNARVIM_RUNTIME_DIR/lvim/init.lua" "$@"
|
|
|
|
|
2021-05-03 02:14:39 +02:00
|
|
|
```
|
2021-04-29 07:36:13 +02:00
|
|
|
|
2021-07-03 02:58:53 +02:00
|
|
|
## Resources
|
2021-04-04 23:21:57 +02:00
|
|
|
|
2021-07-29 14:10:21 +02:00
|
|
|
- [Documentation](https://www.lunarvim.org)
|
2021-03-27 01:28:08 +01:00
|
|
|
|
2021-09-02 17:22:51 +02:00
|
|
|
- [YouTube](https://www.youtube.com/channel/UCS97tchJDq17Qms3cux8wcA)
|
|
|
|
|
2021-07-03 02:58:53 +02:00
|
|
|
- [Discord](https://discord.gg/Xb9B4Ny)
|
2021-03-22 01:59:02 +01:00
|
|
|
|
2021-07-03 02:58:53 +02:00
|
|
|
- [Twitter](https://twitter.com/chrisatmachine)
|
2021-06-30 20:28:26 +02:00
|
|
|
|
2021-07-05 21:32:45 +02:00
|
|
|
## Testimonials
|
|
|
|
|
|
|
|
> "I have the processing power of a potato with 4 gb of ram and LunarVim runs perfectly."
|
|
|
|
> - @juanCortelezzi, LunarVim user.
|
2021-06-30 20:28:26 +02:00
|
|
|
|
2021-07-10 05:02:42 +02:00
|
|
|
> "My minimal config with a good amount less code than LunarVim loads 40ms slower. Time to switch."
|
|
|
|
> - @mvllow, Potential LunarVim user.
|
|
|
|
|
2021-07-13 03:57:12 +02:00
|
|
|
<div align="center" id="madewithlua">
|
2021-07-06 15:50:53 +02:00
|
|
|
|
2021-07-13 03:57:12 +02:00
|
|
|
[![Lua](https://img.shields.io/badge/Made%20with%20Lua-blue.svg?style=for-the-badge&logo=lua)](#madewithlua)
|
2021-07-06 15:50:53 +02:00
|
|
|
|
|
|
|
</div>
|