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

Fix broken README #52

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Fix broken README #52

wants to merge 4 commits into from

Conversation

mohan3d
Copy link

@mohan3d mohan3d commented Oct 14, 2017

  1. README was written in rst format but had .md extension.
  2. Fixed some problems with rst format.
  3. Updated documentation section urls (License, contributing).
  4. Updated direct install using pip and repository url.
  5. Fixed Travis url.

If you try to install directly from the repository pip will not be able to install since the repository url must be prefixed with git+

even when you fix this installation will fail with this message. (look at this line this is the problem we don't have a README.rst file)
IOError: [Errno 2] No such file or directory: 'README.rst'

Travis url is linking for the old repository (build status unknown).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant