opentui
opentui copied to clipboard
Suggested README improvements to clarify scope and help new contributors
Hi , I’ve found your repository very useful — thank you for making it open source.
While reading through the README, I took some time to improve the structure/clarity:
- Clear project overview and status.
- Monorepo structure and packages, including maintenance status of each binding.
- Architecture and core modules outline mapped to repository paths.
- Key functions/classes summary with inputs/outputs to set expectations.
- Prerequisites, installation, and example execution steps (no code snippets).
- Testing, releases, versioning, and governance basics (default branch, CODEOWNERS).
I didn’t want to push directly on your repo without asking — so I created a fork to showcase what I mean. You can review it here: https://github.com/thomgit9/opentui/blob/main/README.md
If you think some of these changes make sense, I’d be happy to open a PR.
Let me know if you’d like me to propose this as a PR directly.
Thanks again for the project — it’s been very helpful.
Best,