Add demo video on readme#3
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR enhances the README documentation by adding a demo GIF and improving the installation instructions. The changes make the project more accessible to new users by showing a visual demonstration upfront and prioritizing simple installation methods via pipx/pip before the source installation option.
Changes:
- Added a demo GIF reference to showcase the application visually
- Reorganized installation instructions to prioritize pipx/pip installation over source installation
- Corrected the GitHub repository URL from
douglastoDouglas019BRto match the actual repository - Updated the license section formatting
- Added
.mypy_cache/to .gitignore for Python type checking cache files
Reviewed changes
Copilot reviewed 1 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Added demo GIF, improved installation section organization, corrected GitHub URL, and updated license formatting |
| .gitignore | Added .mypy_cache/ entry for Python type checking tool cache |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
No description provided.