diff options
| author | Craig Jennings <c@cjennings.net> | 2025-11-08 11:57:49 -0600 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2025-11-08 11:57:49 -0600 |
| commit | 29b559bd1a956a4efdec625f1b5d878503d46a33 (patch) | |
| tree | f11923009fca97851098430b3fe9746376792bb0 /tests/README-DEBUG-TESTS.md | |
| parent | 1f40ef408641680c951a65b72be240d9b7729d8e (diff) | |
docs: add critical setup rules for local development and debugging
Added two new sections to README:
1. "Local Development / Manual Install" section:
- Shows correct pattern for loading xterm-color in :preface
- Explains :demand t ensures immediate loading
- Provides both use-package and manual install examples
- Emphasizes xterm-color must load BEFORE wttrin
2. "Debugging and Troubleshooting" section:
- Documents wttrin-debug must be set BEFORE loading wttrin
- Shows correct vs incorrect examples (with ❌ for wrong way)
- Explains how to view debug log with M-x wttrin--debug-show-log
- Includes example debug output
- Lists common issues and solutions
Key rules documented:
- xterm-color in :preface with :demand t for local development
- wttrin-debug set before (require 'wttrin) or use-package declaration
- Debug checked at load time, can't be set in :custom section
These are common pitfalls that prevented wttrin from loading correctly.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
Diffstat (limited to 'tests/README-DEBUG-TESTS.md')
0 files changed, 0 insertions, 0 deletions
