Description
The README.md needs a few documentation improvements and fixes to improve readability, navigation, and overall presentation for users visiting the repository.
This issue contains 4 small README-related tasks.
Tasks
1. Rearrange Social Handles Order
The organization/project social badges currently appear in a different order.
Please rearrange them in the following order:
- Discord
- X (Twitter)
- LinkedIn
- Medium
- Telegram
- YouTube
Only the ordering needs to be updated.
2. Add Download / Release Links
The project recently released v1.1.0, and the README should include quick access download links for users.
Add a small section/buttons for:
- Download for Windows
- Download for macOS
- Download for Linux
- Or a general “Check Releases” section/button
Feel free to follow standard open-source README practices for presenting release/download links.
3. Fix Light/Dark Mode Architecture Diagram
The High Level Architecture diagram is intended to automatically switch between light and dark mode images based on GitHub appearance settings, but the current implementation is not working correctly.
Current implementation:
## High Level Architecture
<div align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/architectual-design-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="docs/assets/architectual-design-light.svg">
<img src="docs/assets/architectual-design-light.svg" alt="PictoPy architecture diagram">
</picture>
</div>
The task is to fix the implementation so the correct image is displayed for both light and dark GitHub themes.
4. Fix Contributor Thank You Note
At the end of the README, the following text currently exists:
## Thanks To All Contributors
Thanks a lot for spending your time helping TODO grow. Keep rocking 🥂
Replace TODO with PictoPy.
Expected Outcome
- Better organized README social section
- Easier access to project downloads/releases
- Proper light/dark theme support for architecture diagrams
- Correct contributor appreciation message
Additional Notes
- All changes are limited to the
README.md file.
- Keep formatting consistent with the existing README style.
Description
The
README.mdneeds a few documentation improvements and fixes to improve readability, navigation, and overall presentation for users visiting the repository.This issue contains 4 small README-related tasks.
Tasks
1. Rearrange Social Handles Order
The organization/project social badges currently appear in a different order.
Please rearrange them in the following order:
Only the ordering needs to be updated.
2. Add Download / Release Links
The project recently released v1.1.0, and the README should include quick access download links for users.
Add a small section/buttons for:
Feel free to follow standard open-source README practices for presenting release/download links.
3. Fix Light/Dark Mode Architecture Diagram
The High Level Architecture diagram is intended to automatically switch between light and dark mode images based on GitHub appearance settings, but the current implementation is not working correctly.
Current implementation:
The task is to fix the implementation so the correct image is displayed for both light and dark GitHub themes.
4. Fix Contributor Thank You Note
At the end of the README, the following text currently exists:
## Thanks To All Contributors Thanks a lot for spending your time helping TODO grow. Keep rocking 🥂Replace
TODOwithPictoPy.Expected Outcome
Additional Notes
README.mdfile.