diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 92 |
1 files changed, 59 insertions, 33 deletions
@@ -1,14 +1,14 @@  <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 href="https://github.com/lunarvim/LunarVim/releases/latest"> + <img alt="Latest release" src="https://img.shields.io/github/v/release/lunarvim/LunarVim" /> </a> - <a href="https://github.com/ChristianChiarulli/LunarVim/pulse"> - <img alt="Last commit" src="https://img.shields.io/github/last-commit/ChristianChiarulli/LunarVim"/> + <a href="https://github.com/lunarvim/LunarVim/pulse"> + <img alt="Last commit" src="https://img.shields.io/github/last-commit/lunarvim/LunarVim"/> </a> - <a href="https://github.com/ChristianChiarulli/LunarVim/blob/main/LICENSE"> - <img src="https://img.shields.io/github/license/siduck76/NvChad?style=flat-square&logo=GNU&label=License" alt="License" + <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" /> <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" /> @@ -25,22 +25,26 @@ Make sure you have the newest version of Neovim (0.5). ``` bash -bash <(curl -s https://raw.githubusercontent.com/ChristianChiarulli/lunarvim/master/utils/installer/install.sh) +bash <(curl -s https://raw.githubusercontent.com/lunarvim/lunarvim/master/utils/installer/install.sh) ``` ### Installing The following command installs LunarVim. Change `LVBRANCH` to the branch you'd like to install. `master` for the stable branch and `rolling` for the latest changes. ``` bash -LVBRANCH=rolling bash <(curl -s https://raw.githubusercontent.com/ChristianChiarulli/lunarvim/rolling/utils/installer/install.sh) +LVBRANCH=rolling bash <(curl -s https://raw.githubusercontent.com/lunarvim/lunarvim/rolling/utils/installer/install.sh) ``` ### BREAKING CHANGE on rolling and master branches -* The latest changes to LunarVim require you to [remove it completely](https://github.com/ChristianChiarulli/LunarVim/wiki/Uninstalling-LunarVim) before upgrading +* The latest changes to LunarVim require you to [remove it completely](https://github.com/lunarvim/LunarVim/wiki/Uninstalling-LunarVim) before upgrading * Going forward LunarVim will no longer reside in the nvim configuration folder. LunarVim has been moved to `~/.local/share/lunarvim`. * To launch Lunarvim use the new `lvim` command. `nvim` will only launch standard neovim. -* Your personal configuration file (`lv-config.lua`) can now be found in `~/.config/lvim`. You can initialize this folder as a git repository to track changes to your configuration files. +* Your personal configuration file (`config.lua`) can now be found in `~/.config/lvim`. You can initialize this folder as a git repository to track changes to your configuration files. * If you want to keep launching LunarVim with the `nvim` command, add an alias entry to your shell's config file: `alias nvim=lvim`. To temporarily revert to the default `nvim` prefix it with a backslash `\nvim`. -* Many options formerly available in `lv-config.lua` have been renamed. For details [look here](https://github.com/ChristianChiarulli/LunarVim/wiki/Breaking-changes-in-rolling) +* Many options formerly available in `config.lua` have been renamed. For details [look here](https://github.com/lunarvim/LunarVim/wiki/Breaking-changes-in-rolling) + +### Debugging LunarVim's configuration +* To turn on debugging add these settings `lvim.log.level = debug` and use `<leader>Ll` to see the options of viewing the logfiles +* You can also use install [lnav](https://github.com/tstack/lnav) and use it in a floating terminal. Make sure to set `lvim.builtin.terminal.active = true`. ### Fixing installation problems If your installation is stuck on `Ok to remove? [y/N]`, it means there are some leftovers, \ @@ -51,7 +55,7 @@ you can run the script with `--overwrite` but be warned this will remove the fol - `~/.local/share/lunarvim` #Removed only on Rolling Branch - `~/.config/lvim` #Removed only on Rolling Branch ```bash -curl -s https://raw.githubusercontent.com/ChristianChiarulli/lunarvim/rolling/utils/installer/install.sh | LVBRANCH=rolling bash -s -- --overwrite +curl -s https://raw.githubusercontent.com/lunarvim/lunarvim/rolling/utils/installer/install.sh | LVBRANCH=rolling bash -s -- --overwrite ``` then run nvim and wait for treesitter to finish the installation @@ -60,13 +64,13 @@ then run nvim and wait for treesitter to finish the installation Just enter `:LspInstall` followed by `<TAB>` to see your options -**NOTE** I recommend installing `lua` for autocomplete in `lv-config.lua` +**NOTE** I recommend installing `lua` for autocomplete in `config.lua` -For the julia language server look [here](https://github.com/ChristianChiarulli/LunarVim/wiki/Enabling-a-language-server#julia-support) +For the julia language server look [here](https://github.com/lunarvim/LunarVim/wiki/Enabling-a-language-server#julia-support) ## Configuration file -To activate other plugins and language features use the `lv-config.lua` file provided in the `nvim` folder (`~/.config/nvim/lv-config.lua`) in the master branch or (`~/.config/lvim/lv-config.lua`) on rolling +To activate other plugins and language features use the `lv-config.lua` file provided in the `nvim` folder (`~/.config/nvim/lv-config.lua`) in the master branch or (`~/.config/lvim/config.lua`) on rolling Example: @@ -78,8 +82,28 @@ lvim.colorscheme = "spacegray" lvim.builtin.compe.autocomplete = true --- keymappings +-- keymappings [view all the defaults by pressing <leader>Lk] 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>lua require'telescope'.extensions.project.project{}<CR>", "Projects" } +-- lvim.builtin.which_key.mappings["t"] = { +-- name = "+Trouble", +-- r = { "<cmd>Trouble lsp_references<cr>", "References" }, +-- f = { "<cmd>Trouble lsp_definitions<cr>", "Definitions" }, +-- d = { "<cmd>Trouble lsp_document_diagnostics<cr>", "Diagnosticss" }, +-- q = { "<cmd>Trouble quickfix<cr>", "QuickFix" }, +-- l = { "<cmd>Trouble loclist<cr>", "LocationList" }, +-- w = { "<cmd>Trouble lsp_workspace_diagnostics<cr>", "Diagnosticss" }, +-- } -- After changing plugin config exit and reopen LunarVim, Run :PackerInstall :PackerCompile lvim.builtin.dashboard.active = true @@ -90,11 +114,24 @@ lvim.builtin.treesitter.ensure_installed = "maintained" lvim.builtin.treesitter.ignore_install = { "haskell" } lvim.builtin.treesitter.highlight.enabled = true -lvim.lang.python.formatter.exe = "black" -lvim.lang.python.linters = "" - lvim.lsp.diagnostics.virtual_text = false +-- 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 = {} + } +} + + -- Additional Plugins lvim.plugins = { {"lunarvim/colorschemes"}, @@ -110,17 +147,6 @@ lvim.plugins = { -- { "BufWinEnter", "*.lua", "setlocal ts=8 sw=8" }, -- } --- Additional Leader bindings for WhichKey --- lvim.builtin.which_key.mappings["P"] = { "<cmd>lua require'telescope'.extensions.project.project{}<CR>", "Projects" } --- lvim.builtin.which_key.mappings["t"] = { --- name = "+Trouble", --- r = { "<cmd>Trouble lsp_references<cr>", "References" }, --- f = { "<cmd>Trouble lsp_definitions<cr>", "Definitions" }, --- d = { "<cmd>Trouble lsp_document_diagnostics<cr>", "Diagnosticss" }, --- q = { "<cmd>Trouble quickfix<cr>", "QuickFix" }, --- l = { "<cmd>Trouble loclist<cr>", "LocationList" }, --- w = { "<cmd>Trouble lsp_workspace_diagnostics<cr>", "Diagnosticss" }, --- } ``` @@ -149,7 +175,7 @@ cd ~/.local/share/lunarvim/lvim && git pull :PackerSync ``` -To update Neovim use your package manager or [compile from source](https://github.com/ChristianChiarulli/LunarVim/wiki/Installation#get-the-latest-version-of-neovim) +To update Neovim use your package manager or [compile from source](https://github.com/lunarvim/LunarVim/wiki/Installation#get-the-latest-version-of-neovim) ## Project Goals @@ -165,7 +191,7 @@ To update Neovim use your package manager or [compile from source](https://githu - 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 + - Hot install of lsp/treesitter/formatter required upon opening 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 @@ -178,7 +204,7 @@ To update Neovim use your package manager or [compile from source](https://githu - [YouTube](https://www.youtube.com/channel/UCS97tchJDq17Qms3cux8wcA) -- [Wiki](https://github.com/ChristianChiarulli/LunarVim/wiki) +- [Documentation](https://www.lunarvim.org) - [Discord](https://discord.gg/Xb9B4Ny) |