Streamline the README #1072
Merged
Streamline the README #1072
Conversation
This file contains hidden or 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
Member
|
A few suggestions:
|
Member
Author
|
All great suggestions, I agree, I'll pick these up tomorrow 👍 :) |
- smaller tournament with a more readable image: linked to the one from the documentation. - reduce the size of the fingerprint image: I think I've done this correctly. Let's see what it looks like rendered... - still mention that classics like WSLS are included: done. - maybe link the capabilities straight to the relevant section in the docs: I think I've caught all these.
marcharper
approved these changes
Jul 18, 2017
Member
marcharper
left a comment
marcharper
left a comment
There was a problem hiding this comment.
LGTM. I think we'll want to add the publications back in as a section at some point (can re-evaluate when relevant soon).
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.
Here's my streamlining of the README - discussions at #1047. I had it lying around and think it's better than the status quo.
You can view it here: https://github.com/Axelrod-Python/Axelrod/blob/readme-revamp/README.rst