renken/nvim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc(readme): document personal notes

Browse source
This commit is contained in:
Renken 2024-08-19 17:46:53 +02:00
parent a5c94554a9
commit a51ae13b83
Signed by: renken
GPG key ID: 1F2BB159B645E575
1 changed files with 23 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -10,6 +10,28 @@ A starting point for Neovim that is:
**NOT** a Neovim distribution, but instead a starting point for your configuration.
## Renken's notes
### Divergence from upstream
I try to stay as up-to-date as possible with upstream. However certain commits
that I deliberately skipped cherry-picking because they can be problematic. I
will try to document all of them below.
* [nvim-lua/kickstart@7513ec8](https://github.com/nvim-lua/kickstart.nvim/commit/7513ec8a7dd579957ce2d9b44e05c1da18d7d0e3)
deletes `numToStr/Comment.nvim` without justification. Possibly this feature
was merged in `neovim-v0.10.0`? The changes to use `vim.uv` instead of
`vim.loop` were not included as a result. I also want to take the time to
understand what `neodev` and `lazydev` do before integrating the latter. Future
commits related to it will not be included here either, such as.
* [nvim-lua/kickstart@fd66454](https://github.com/nvim-lua/kickstart.nvim/commit/fd66454c4a02abb44568159e7447060b962e1b5d).
* Debian GNU/Linux packages
[`markdownlint`](https://packages.debian.org/bookworm-backports/markdownlint).
However, the binary is installed under `/bin/mdl` which breaks
`lua/kickstart/plugins/lint.lua`. Make sure to execute `ln -s /bin/mdl
~/.local/bin/markdownlint` or something similar.
## Installation
### Install Neovim
@ -131,7 +153,7 @@ examples of adding popularly requested plugins.
* The main purpose of kickstart is to serve as a teaching tool and a reference
configuration that someone can easily use to `git clone` as a basis for their own.
As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
into smaller parts. A fork of kickstart that does this while maintaining the
into smaller parts. A fork of kickstart that does this while maintaining the
same functionality is available here:
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
* Discussions on this topic can be found here:
@ -226,4 +248,3 @@ sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
```
</details>