From b37eae375e03f9e3bc3da1f2666e8122bafd0a9e Mon Sep 17 00:00:00 2001
From: Daniel Fichtinger <daniel@ficd.ca>
Date: Sun, 15 Jun 2025 16:52:48 -0400
Subject: [PATCH] AutoYADM commit: 2025-06-15 16:52:48

---
 .config/kak/README.md | 53 +++++++++++++++++++++++++++++++++++++++++++
 .config/kak/kakrc     |  1 +
 2 files changed, 54 insertions(+)
 create mode 100644 .config/kak/README.md

diff --git a/.config/kak/README.md b/.config/kak/README.md
new file mode 100644
index 00000000..814f5e04
--- /dev/null
+++ b/.config/kak/README.md
@@ -0,0 +1,53 @@
+<h1>Daniel's Personal `kakrc`</h1>
+
+This is my personal Kakoune configuration. I use autoyadm to keep the upstream
+repository up-to-date. I'll do my best to document everything, but note that
+this document may be out-of-date at any given time -- my configuration tends to
+evolve quickly.
+
+## Bindings
+
+I type on the Colemak-DH layout. [autoload/colemak.kak](./autoload/colemak.kak)
+rebinds many default keys. If the bindings in `kakrc` seem strange, that's why.
+
+## Plugins
+
+I use `kak-bundle` to install some external plugins. Many others, I simply copy
+the upstream code directly into my config. Some plugins I've written myself have
+been separated into other repositories. Check
+[git.sr.ht/~ficd](https://git.sr.ht/~ficd) to find them.
+
+## Organization
+
+- `kakrc` mainly contains mappings, utility commands, and setup that depends on
+  plugins/modules from `autoload` being present. (_`autoload` doesn't guarantee
+  any load order_).
+- [`scripts`](./scripts) contains scripts written in formats other than Kakoune.
+- [`autoload`](#autoload) contains everything that isn't in `kakrc`.
+
+### Autoload
+
+- `stdlib` contains symlinks to the standard RC in `/usr/share/kak/rc`. The
+  reason I don't symlink then entire directory is to retain control over which
+  files are actually loaded, in case I want to override any.
+- `detection` contains patched versions of standard RC files.
+- `filetype` contains custom filetype support.
+- `fishr` is a module for writing expansions in `fish` shell.
+- `bootstrap.kak` installs external dependencies of my configuration. Untested
+  and likely out-of-date.
+- `byline.kak` is a fork of a plugin adding Helix-like `x` and `X` commands.
+- `clipboard.kak` has `wl-clipboard` integration.
+- `colemak.kak` rebinds defaults according to my preferences as a Colemak-DH
+  user.
+- `filetype.kak` contains some filetype-specific logic like setting up
+  formatters.
+- `format.kak` is my patch of the standard RC formatter.
+- `git-mode.kak` has Git-related commands and bindings.
+- `grep.kak` has some convenience functionality built on standard RC `grep`
+  module.
+- `helix-scroll.kak` improves the `<c-u>` command.
+- `hop.kak` setup for the `hop.kak` plugin.
+- `hump.kak` modified external plugin.
+- `insert-mode.kak` defines convenience mappings for insert mode.
+- `lsp.kak` contains my `kakoune-lsp` configuration with some custom logic and
+  functions.
diff --git a/.config/kak/kakrc b/.config/kak/kakrc
index c288cad5..1d7b8597 100644
--- a/.config/kak/kakrc
+++ b/.config/kak/kakrc
@@ -1,5 +1,6 @@
 # Daniel's Personal kakrc
 # Author: Daniel Fichtinger <daniel@ficd.ca>
+# See README.md for explanations.
 # Feel free to steal & modify any of it.
 # Notes:
 # I use colemak-dh keyboard layout. autoload/colemak.kak