Skip to content

README refactor for 0.5.0 - #13

Merged
QaidVoid merged 4 commits into
pkgforge:mainfrom
pkgforge-dev:main
Jan 27, 2025
Merged

README refactor for 0.5.0#13
QaidVoid merged 4 commits into
pkgforge:mainfrom
pkgforge-dev:main

Conversation

@Azathothas

@AzathothasAzathothas commented Jan 12, 2025

Copy link
Copy Markdown
Member

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

@AzathothasAzathothas changed the title refactor for 0.4.9README refactor for 0.4.9Jan 12, 2025
@AzathothasAzathothas changed the title README refactor for 0.4.9README refactor for 0.5.0Jan 12, 2025
@QaidVoid
QaidVoid marked this pull request as ready for review January 27, 2025 15:14
Azathothasand others added 4 commits January 27, 2025 21:04
Signed-off-by: Ajam <AjamX101@gmail.com>
Signed-off-by: Ajam <AjamX101@gmail.com>
Signed-off-by: Ajam <AjamX101@gmail.com>
@QaidVoid
QaidVoid merged commit 25a3947 into pkgforge:mainJan 27, 2025
@QaidVoidQaidVoid mentioned this pull request Dec 26, 2025
This was referenced Feb 13, 2026
Sign up for freeto 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

@Azathothas@QaidVoid