Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README refactor for 0.5.0 #13

Merged
merged 4 commits into from
Jan 27, 2025
Merged

README refactor for 0.5.0 #13

merged 4 commits into from
Jan 27, 2025

Conversation

Azathothas
Copy link
Member

@Azathothas Azathothas commented Jan 12, 2025

For eventual 0.5.0, we need some changes in the readme

  1. Removed Redundant GIFs

No longers show new args/options/output & it's too much work to keep generating and updating them with every major release. And the default generated one is good enough

Warning

Upon each major release, make sure to change the <img src="https://soar.pkgforge.dev/gif?version=v0.4.8" to ?version=${new_version}, this is just to force github to cache new gif (will show updated/more number of packages)

  1. Added Package shields & other graphs
  2. Removed --help and other things

put links to docs, again to cut down time to keep updating it with major release, and we should just update one docs each that applies to everything


Feel free to correct typos, links or rephrase certain things
This is how it currently looks: https://github.com/pkgforge-dev/soar/tree/main

@Azathothas Azathothas changed the title refactor for 0.4.9 README refactor for 0.4.9 Jan 12, 2025
@Azathothas Azathothas changed the title README refactor for 0.4.9 README refactor for 0.5.0 Jan 12, 2025
@QaidVoid QaidVoid marked this pull request as ready for review January 27, 2025 15:14
Signed-off-by: Ajam <[email protected]>
Signed-off-by: Ajam <[email protected]>
Signed-off-by: Ajam <[email protected]>
@QaidVoid QaidVoid merged commit 25a3947 into pkgforge:main Jan 27, 2025
1 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants