LunarVim/README.md

119 lines
3.2 KiB
Markdown
Raw Normal View History

2021-06-30 06:55:40 +02:00
![LunarVim Demo](./utils/media/lunarvim_logo_dark.png)
2021-06-30 20:28:26 +02:00
<div align="center"><p>
<a href="https://github.com/ChristianChiarulli/LunarVim/releases/latest">
<img alt="Latest release" src="https://img.shields.io/github/v/release/ChristianChiarulli/LunarVim" />
</a>
<a href="https://github.com/ChristianChiarulli/sniprun/releases">
2021-06-30 20:30:30 +02:00
<img alt="Total downloads" src="https://img.shields.io/github/downloads/ChristianChiarulli/LunarVim/total" />
2021-06-30 20:28:26 +02:00
</a>
<a href="https://github.com/ChristianChiarulli/LunarVim/pulse">
<img alt="Last commit" src="https://img.shields.io/github/last-commit/ChristianChiarulli/LunarVim"/>
</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" />
</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>
</p>
</div>
2021-03-27 19:32:45 +01:00
2021-07-03 02:58:53 +02:00
## Install In One Command!
Make sure you have the newest version of Neovim (0.5).
``` bash
2021-07-03 02:58:53 +02:00
bash <(curl -s https://raw.githubusercontent.com/ChristianChiarulli/lunarvim/stable/utils/installer/install.sh)
2021-03-15 03:25:28 +01:00
```
2021-07-03 02:58:53 +02:00
## Installing LSP for your language
2021-07-03 02:58:53 +02:00
Just enter `:LspInstall` followed by `<TAB>` to see your options
2021-07-03 02:58:53 +02:00
**NOTE** I recommend installing `lua` language support to make work
2021-07-03 02:58:53 +02:00
## Configuration file
2021-07-03 02:58:53 +02:00
To activate other plugins and language features use the `lv-config.lua` file provided in the `nvim` folder (`~/.config/nvim/lv-config.lua`)
Example:
```lua
2021-07-03 02:58:53 +02:00
-- O is the global options object
2021-07-03 02:58:53 +02:00
-- THESE ARE EXAMPLE CONFIGS FEEL FREE TO CHANGE TO WHATEVER YOU WANT
-- general
O.auto_complete = true
O.relative_number = false
O.colorscheme = 'spacegray'
O.timeoutlen = 100
O.leader_key = ' '
2021-07-03 02:58:53 +02:00
-- After changing plugin config it is recommended to run :PackerCompile
O.plugin.hop.active = true
O.plugin.colorizer.active = true
O.plugin.trouble.active = true
O.plugin.lazygit.active = true
O.plugin.zen.active = true
O.plugin.markdown_preview.active = true
2021-07-03 02:58:53 +02:00
-- if you don't want all the parsers change this to a table of the ones you want
O.treesitter.ensure_installed = "all"
O.treesitter.ignore_install = {"haskell"}
O.treesitter.highlight.enabled = true
2021-07-03 02:58:53 +02:00
-- lua
O.lang.lua.autoformat = false
O.lang.lua.formatter = 'lua-format'
2021-07-03 02:58:53 +02:00
-- javascript
O.lang.tsserver.formatter = 'prettier'
O.lang.tsserver.linter = nil
O.lang.tsserver.autoformat = true
2021-07-03 02:58:53 +02:00
-- json
O.lang.json.autoformat = true
```
2021-07-03 02:58:53 +02:00
**NOTE** After changing a setting it is important to exit LunarVim and run the following:
```
:PackerInstall
:PackerCompile
```
2021-07-03 02:58:53 +02:00
## Updating LunarVim
2021-07-03 02:58:53 +02:00
In order to update you should be aware of three things `Plugins`, `LunarVim` and `Neovim`
2021-07-03 02:58:53 +02:00
To update plugins:
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-03 02:58:53 +02:00
cd ~/.config/nvim && git pull
```
2021-07-03 02:58:53 +02:00
## Resources
2021-04-04 23:21:57 +02:00
2021-07-03 02:58:53 +02:00
- [YouTube](https://www.youtube.com/channel/UCS97tchJDq17Qms3cux8wcA)
2021-03-23 03:09:11 +01:00
2021-07-03 02:58:53 +02:00
- [Wiki](https://github.com/ChristianChiarulli/LunarVim/wiki)
2021-03-27 01:28:08 +01:00
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
## 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