robert/nVim
1
0
Fork 0
Code Issues Pull Requests Releases Activity

doc: update readme

Browse Source
This commit is contained in:
Robert Morrison 2026-04-10 03:01:32 +01:00
parent f2161af221
commit b09b93973e
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
readme.md
View File

@ -7,6 +7,12 @@ This time instead of copying large swathes of config from my previous
setup, the majority of this is a clean rewrite, and at current is not fully setup, the majority of this is a clean rewrite, and at current is not fully
implemented. implemented.
# Note:
this readme is not guaranteed to be up-to-date
Changes happen fast. and I don't always have time to document things.
Ideally if this becomes stabilised I will have the time/need to document
better
# Currently missing # Currently missing
The current major feature that is missing is I do not have any keybinds set The current major feature that is missing is I do not have any keybinds set
@ -26,3 +32,18 @@ different purposes. However actually this just increases the time it takes
to make changes, as often changes to plugin spec also require some amount to make changes, as often changes to plugin spec also require some amount
of change in the plugin config. Also this means that everything relating to of change in the plugin config. Also this means that everything relating to
a single plugin is contained in one place and not spread across two files a single plugin is contained in one place and not spread across two files
# Oddities
# `lua/plugins/spec/builtin.lua`
This file contains virtual plugin entries that allows me to load
built-in plugins using lazy.
I load `nvim.undotree` and `nohlsearch` this way.
# typing longer options
So that I can understand this when I need to make changes I try not to make
abbreviations or aliases for built-in functions,
I also refrain from using the short names for options unless they are just
as descriptive as the full name.
This way I can actually understand my config when I come back to edit it
every month or so.