You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(README): restore interactive examples and doctest coverage
why: The refreshed README removed valuable interactive examples that
help users learn the API through hands-on experimentation.
what:
- Restore ptpython/ipython REPL tips for exploring the API
- Add tmuxp shell shortcut tip for power users
- Restore doctest examples: session/window control, pane splitting
- Add capture-pane output example with doctest +SKIP
- Add hierarchy traversal examples (pane.window.session)
- Add architecture/about link to project links
- Emphasize The Tao of tmux book link
- Remove duplicate "Raw tmux when you need it" section
- All 12 README doctests pass via `uv run pytest README.md --doctest-glob="*.md"`
@@ -158,21 +258,23 @@ print(result.returncode) # 0 on success
158
258
159
259
- Docs: [docs]
160
260
- API reference: [api]
261
+
- Architecture: [architecture]
161
262
- Changelog: [history]
162
263
- Migration notes: [migration]
163
264
- Issues: [issues]
164
265
- Test coverage: [coverage]
165
266
- Releases: [releases]
166
267
- License: [license]
167
268
- Support: [support]
168
-
- The Tao of tmux book: [tao]
269
+
-**[The Tao of tmux][tao]** — deep-dive book on tmux fundamentals
169
270
170
271
## Contributing & support
171
272
172
273
Contributions are welcome. Please open an issue or PR if you find a bug or want to improve the API or docs. If libtmux helps you ship, consider sponsoring development via [support].
0 commit comments