diff --git a/readme.md b/readme.md index 09e29d1..6c39c1a 100644 --- a/readme.md +++ b/readme.md @@ -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 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 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 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 + +# 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.