aboutsummaryrefslogtreecommitdiff
path: root/vendor/libghostty-vt/src/cli/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/libghostty-vt/src/cli/README.md')
-rw-r--r--vendor/libghostty-vt/src/cli/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/vendor/libghostty-vt/src/cli/README.md b/vendor/libghostty-vt/src/cli/README.md
new file mode 100644
index 00000000..7a1d9940
--- /dev/null
+++ b/vendor/libghostty-vt/src/cli/README.md
@@ -0,0 +1,13 @@
+# Subcommand Actions
+
+This is the cli specific code. It contains cli actions and tui definitions and
+argument parsing.
+
+This README is meant as developer documentation and not as user documentation.
+For user documentation, see the main README or [ghostty.org](https://ghostty.org/docs).
+
+## Updating documentation
+
+Each cli action is defined in it's own file. Documentation for each action is defined
+in the doc comment associated with the `run` function. For example the `run` function
+in `list_keybinds.zig` contains the help text for `ghostty +list-keybinds`.