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

Improve README #114

Merged
merged 3 commits into from May 1, 2016

Conversation

Projects
None yet
3 participants
@cirosantilli
Contributor

cirosantilli commented May 1, 2016

Improve the readme. Includes the commit at: #113 as there would be a conflict otherwise.

cirosantilli added some commits May 1, 2016

Improve README
- clarify that this is a library, and not just some examples
- make code organization clearer with a new header level.
    This requires using # headers for ###, so I converted everything to it
    for uniformity.
- make contributors h2. There should only be a single h1 per file.

@cirosantilli cirosantilli force-pushed the cirosantilli:readme branch from 85c097d to 6ae5b90 May 1, 2016

@rougier

This comment has been minimized.

Owner

rougier commented May 1, 2016

Many thanks ! Don't forget your name in the contributors...

@cirosantilli

This comment has been minimized.

Contributor

cirosantilli commented May 1, 2016

@rougier done! Personally, I don't care much, Git knows ;-) But I'll stick to project standards.

@rougier rougier merged commit ac2e1ed into rougier:master May 1, 2016

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@rougier

This comment has been minimized.

Owner

rougier commented May 1, 2016

Thanks. You're right, git knows everything :)

@yairchu

This comment has been minimized.

Contributor

yairchu commented on INSTALL.md in 04df9e0 Dec 22, 2016

Btw the linked bug is marked as fixed. Is it still an issue?

This comment has been minimized.

Contributor

cirosantilli replied Dec 27, 2016

@yairchu #144

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment