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

README: revisit installation/usage sections #378

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

Conversation

blueyed
Copy link
Collaborator

@blueyed blueyed commented Mar 20, 2020

@Maltimore
Copy link

I think installing with pip directly from the repo is the best way, I hadn't thought of that. Two comments:

  • I would put the note regarding installing directly from the repo earlier in the README (to make it more visible), for instance in the installation section above "is also available via... [conda]".
  • the :program: blocks you added don't seem to get parsed correctly, at least not in the preview

@blueyed
Copy link
Collaborator Author

blueyed commented May 12, 2021

* I would put the note regarding installing directly from the repo earlier in the README (to make it more visible), for instance in the installation section above "is also available via... [conda]".

Good point, done.

* the `:program:` blocks you added don't seem to get parsed correctly, at least not in the preview

I've removed the usage of that role for now.
The rendering of ReST/Sphinx documents appears to be rather limited on GitHub - the plan there is to move to some more full-fledged docs, where this would make more sense then.

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.

Cannot just put pdb.py in $PYTHONPATH to install (as mentioned in README)
2 participants