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

Improve README #56

Open
rossant opened this issue Jun 14, 2015 · 2 comments
Open

Improve README #56

rossant opened this issue Jun 14, 2015 · 2 comments

Comments

@rossant
Copy link
Owner

rossant commented Jun 14, 2015

  • make it shorter
  • put the installation instructions at the beginning
  • document the CLI conversion tool
@mathcass
Copy link

I can echo a desire for more examples in the README. Through trial and error, I figured out how to use the CLI conversion tool. I tried these incorrect examples:

ipymd POST.ipynb --from ipynb --to md

ipymd POST.ipynb --from .ipynb --to .md

only for this correct one to work:

ipymd POST.ipynb --from notebook --to markdown

It wasn't clear to me from the README what the valid values were for the to and from arguments.


BTW, thanks for the neat tool.

@rossant
Copy link
Owner Author

rossant commented Feb 27, 2017

100% agree, PR welcome! Thanks.

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

No branches or pull requests

2 participants