mirror of
https://github.com/LunarVim/LunarVim.git
synced 2024-09-20 18:45:08 +02:00
docs: Update Readme (#3282)
* Update Readme Something like this to start * Update README.md
This commit is contained in:
umop3plsdn
GitHub
parent
c015d0feee
commit
9bac113603
1 changed files with 20 additions and 129 deletions
149
README.md
149
README.md
|
|
@ -18,7 +18,16 @@
|
|||
</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
A community driven Neovim IDE
|
||||
|
||||
---
|
||||
|
||||
**[<kbd> <br> Install <br> </kbd>][Install]**
|
||||
**[<kbd> <br> Configure <br> </kbd>][Configure]**
|
||||
**[<kbd> <br> Troubleshooting <br> </kbd>][Troubleshoot]**
|
||||
**[<kbd> <br> Contribute <br> </kbd>][Contribute]**
|
||||
|
||||
---
|
||||
|
||||
## Showcase
|
||||
|
||||
|
|
@ -28,120 +37,13 @@
|
|||
|
||||
|
||||
|
||||
## Install In One Command!
|
||||
</div>
|
||||
<!----------------------------------------------------------------------------->
|
||||
|
||||
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)
|
||||
|
||||
```powershell
|
||||
Invoke-WebRequest https://raw.githubusercontent.com/LunarVim/LunarVim/master/utils/installer/install.ps1 -UseBasicParsing | Invoke-Expression
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
## 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`
|
||||
[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
|
||||
|
||||
## Resources
|
||||
|
||||
|
|
@ -152,19 +54,8 @@ lvim.plugins = {
|
|||
- [Discord](https://discord.gg/Xb9B4Ny)
|
||||
|
||||
- [Twitter](https://twitter.com/chrisatmachine)
|
||||
## Thanks to all contributors
|
||||
|
||||
## Testimonials
|
||||
|
||||
> "I have the processing power of a potato with 4 gb of ram and LunarVim runs perfectly."
|
||||
>
|
||||
> - @juanCortelezzi, LunarVim user.
|
||||
|
||||
> "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">
|
||||
|
||||
[](#madewithlua)
|
||||
|
||||
</div>
|
||||
<a href="https://github.com/Lunarvim/Lunarvim/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=Lunarvim/Lunarvim" />
|
||||
</a>
|
||||
|
|
|
|||
Loading…
Reference in a new issue