summaryrefslogtreecommitdiff
path: root/README.org
AgeCommit message (Collapse)Author
2025-11-08docs: Use :preface for wttrin-debug instead of external setqCraig Jennings
Update README to show wttrin-debug being set in :preface section of use-package declarations. This is cleaner and follows standard use-package conventions better than requiring users to set variables outside the declaration. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-08refactor: make debug functions public (single hyphen naming)Craig Jennings
Renamed private debug functions to public API: - wttrin--debug-show-log → wttrin-debug-show-log - wttrin--debug-clear-log → wttrin-debug-clear-log Added ;;;###autoload to both functions for proper autoloading. Updated all references: - README.org (2 occurrences) - tests/README-DEBUG-TESTS.md (4 occurrences) - tests/test-wttrin-integration-with-debug.el (8 occurrences) These are user-facing commands that should be discoverable via M-x, so they follow the public API naming convention (single hyphen). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-08docs: add critical setup rules for local development and debuggingCraig Jennings
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>
2025-11-04fix(wttrin): Fix ANSI color rendering on fresh Emacs launchCraig Jennings
Critical bug fix: On fresh Emacs launch, weather displayed with only double quotes colored blue, all other text white. Pressing 'g' to refresh brought colors back. Root cause: wttrin-mode (derived mode) calls kill-all-local-variables internally. The code was setting xterm-color--state buffer-local BEFORE calling wttrin-mode, so the state was immediately wiped out. On refresh, the mode was already active (no-op), so the state survived. Fix: Call wttrin-mode FIRST, then set buffer-local variables after. This ensures kill-all-local-variables runs before we set any state. Changes: - Reorder initialization in wttrin--display-weather (wttrin.el:277-285) - Add regression tests for mode initialization order (2 new tests) Test results: 65 tests, all passing
2025-11-04docs: Update vc-install instructions for Wttrin in READMECraig Jennings
Simplify Emacs Lisp configuration using `:vc` keyword for Wttrin installation and update.
2025-11-04feat:docs: Add mode-line weather display featureCraig Jennings
Introduce mode-line weather display in README.org. Add setup, features, and customization instructions, enabling users to show weather updates directly in the mode-line with automatic refresh and interactive options.
2025-11-04refactor:wttrin: Make asynchronous loading standardCraig Jennings
Make asynchronous loading the only mode of operation. It's well tested and doesn't lock up Emacs during fetching. Synchronous loading code has been removed.
2025-11-04docs: Update README with Emacs 29+ note and advanced settingsCraig Jennings
Add a note for Emacs 29+ users about using `setopt` for type checking. Include sections on asynchronous loading and cache settings under advanced settings, providing customization options for Wttrin's behavior.
2025-11-04docs:README: Add VC install instructionsCraig Jennings
Include detailed steps for installing Wttrin using package-vc in Emacs 30 or later.
2024-04-22wordsmithingCraig Jennings
- fix numbering mistake - swap package installation ordering - word tweaking, probably born out of procrastination
2024-04-22wordsmithingCraig Jennings
2024-04-22Readme RewriteCraig Jennings
- moved the format from markdown to org - much better text IMHO - badges and sections and pictures oh my!