diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/config.md b/docs/config.md new file mode 100644 index 00000000..b3eee911 --- /dev/null +++ b/docs/config.md @@ -0,0 +1,25 @@ +# Startup configuration + +Native pardes builds read a per-user `pardes` file before the first frame: + +- Unix: `$XDG_CONFIG_HOME/pardes`, falling back to `~/.config/pardes`. +- macOS: `$XDG_CONFIG_HOME/pardes` when that variable is set, otherwise + `~/Library/Application Support/pardes`. +- Windows: `%LOCALAPPDATA%\pardes`, with `%USERPROFILE%\AppData\Local\pardes` + as the fallback. + +The browser build has no local user-config path and does not load this file. + +The format is one existing builtin command per line, using the same spelling +and argument parsing as commands executed inside pardes: + +```text +Theme acme +Font DejaVuSansMono-Regular +``` + +Blank, unknown, malformed, or unsuccessful lines are ignored silently, and a +bad line does not prevent later lines from running. Top-level text that is not +a builtin is not sent to a shell. (`Exec ...` remains an ordinary builtin and +therefore keeps its normal behavior.) Key bindings remain compile-time choices +in `src/config.zig`; this startup file does not remap them. |