Ratatui app showcase criteria

[orhun]

Context: I have put this together based on our previous discussions to help sharing our criteria with the future contributors. It could be potentially added as a PR template as well.

Ratatui App Showcase Criteria

We want the showcase to highlight the best-looking and most inspiring Ratatui apps. Ones that make people say "Wow, I want to build something like that!".

To help maintain a high standard, please make sure your app meets most of these guidelines before submitting a PR:

1. The app should have a clean, visually polished design that feels intentional and well-balanced (not cluttered or a prototype).
2. Text must be clearly readable. Use a larger font size (>=16 pt) and a demo width around 1000-1200 px.
3. The demo should focus only on the UI. (hide terminal commands, setup steps, and unrelated output).
4. The purpose of the app should be obvious from a single image or short GIF.
5. The recording should flow smoothly, giving viewers enough time to understand each screen (10-30 seconds).
6. Use color to define structure and meaning, avoid low-contrast or overly monochrome palettes (e.g. gruvbox).
7. Keep layouts tidy. Align elements, use consistent spacing, and avoid large empty areas.
8. Show some interactivity or unique design that demonstrates Ratatui's capabilities.
9. Capture a stable version. Avoid showing crashes, debug info, or error messages.
10. If your app doesn't yet meet this bar, please share it on awesome-ratatui, the forum, or Discord #showcase instead.

Example:

P.S. Check out vhs for recording demos.

[JayanAXHF]

Good work! I would also suggest making a CONTRIBUTING.md and adding this there, so that its easier to access.

[orhun]

Good point!