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

Streamline the README #1072

Merged
merged 5 commits into from
Jul 19, 2017
Merged

Streamline the README #1072

merged 5 commits into from
Jul 19, 2017

Conversation

drvinceknight
Copy link
Member

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

Based on conversation at #1047.
Based on discussion at #1047
Recently someone mentioned using this.
@marcharper
Copy link
Member

A few suggestions:

  • smaller tournament with a more readable image
  • reduce the size of the fingerprint image
  • still mention that classics like WSLS are included
  • maybe link the capabilities straight to the relevant section in the docs?

@drvinceknight
Copy link
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.
Copy link
Member

@marcharper marcharper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants