New readme #231
Merged
New readme #231
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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! |
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.