-
Notifications
You must be signed in to change notification settings - Fork 51
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
New readme #231
New readme #231
Conversation
Kudos, SonarCloud Quality Gate passed! |
Great work! I really like this new style and its a good blend between minimalism and provided enough information. It seems that the logos don't really work in the GitHub dark theme (the letters disappear into the background). I will look into a solution for this. |
Stijn, if you made any progress on the logo's let me know! Would be great if we could merge this. |
I've added a white outline around the logos to make them visible on GitHub's dark theme. This can now be merged! |
Quality Gate passedKudos, no new issues were introduced! 0 New issues |
I tried to see what other projects are doing on their readme:
https://github.com/pytorch/pytorch is very extensive, lots of installation instructions, links to other resources about the project
https://github.com/tensorflow/tensorflow less extensive, mostly a list of resources
https://github.com/dask/dask basically no readme at all, just a few badges
https://github.com/ray-project/ray quite minimalistic as well
I think the approach by Ray strikes a nice balance. So I roughly tried to follow that.
Changes in this pull:
Need to check if nothing breaks now that the readme is again in markdown instead of restructuredtext. This also changes the filename.