docs(readme): add quick example with platform-specific install commands#162
Merged
Conversation
Split Quick Install into Linux/macOS and Windows sections, add a GitHub contributions quick example with an embedded torvalds demo video, and document the flags used.
Clarify that a single piped command creates the GitHub contributions 3D skyline and opens from the generated index.html.
Swap to the new user-attachments asset and autoplay muted so browsers allow playback without user interaction.
Remove autoplay/muted/loop from the README demo video and update the docs Quick Example intro to match the one-command README wording.
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.
Summary
Changes
README.md: platform-specific install commands, quick example commands, demo video, and flag explanationsdocs/src/components/QuickExample.mdx: update intro to start with "Run one command..."Test plan