Repository navigation
Give Oatmeal a polished README with screenshots, demo and tool logos - #3
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Oatmeal's README now leads with the product: an actual desktop screenshot, a lightweight ten-second GIF, provider and coding-agent logos, and a clearer quick start. Separate guides preserve the technical details and explain how desktop exports connect to the original MCP workflow.
The desktop app is explicitly labeled as a preview in PR #2; source instructions select that branch. This change updates documentation and assets only and does not merge the desktop implementation.
Validation: rendered with GitHub's Markdown API, checked at 1200px and 390px in light/dark mode, no broken images or horizontal overflow, all relative file links checked, and independent visual review completed. Demo content is fictional and prepared, with no microphone or cloud calls.