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

[FEATURE] Refactor ReadMe #2401

Open
ParagEkbote opened this issue Jan 11, 2025 · 3 comments
Open

[FEATURE] Refactor ReadMe #2401

ParagEkbote opened this issue Jan 11, 2025 · 3 comments
Labels
enhancement New feature or request

Comments

@ParagEkbote
Copy link

ParagEkbote commented Jan 11, 2025

Is your feature request related to a problem? Please describe.
I think we can refactor the ReadMe and make it a bit simple and decluttered. Firstly, we could add the library logo and reorder the sections such as keeping the introduction, getting started and feature sections to the top and move other sections below. Could you please let me know and I will be happy to contribute with a PR.

timm2

cc: @rwightman

Additional context
The following projects can be considered for reference:

https://github.com/huggingface/diffusers

https://github.com/huggingface/transformers

@ParagEkbote ParagEkbote added the enhancement New feature or request label Jan 11, 2025
@ParagEkbote
Copy link
Author

Gentle ping

cc: @rwightman

@rwightman
Copy link
Collaborator

@ParagEkbote README could use some tweaking but not aiming to make it cookie cutter of the others. There is a TOC for quick jumping. Right now it's not a priority though as I'm trying to work through quite a few large changes so probably makes sense to wait until the dust settles...

@ParagEkbote
Copy link
Author

@rwightman Please free to ping me when it's the time to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants