ipymd icon indicating copy to clipboard operation
ipymd copied to clipboard

Improve README

Open rossant opened this issue 9 years ago • 2 comments

  • make it shorter
  • put the installation instructions at the beginning
  • document the CLI conversion tool

rossant avatar Jun 14 '15 08:06 rossant

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.

mathcass avatar Feb 27 '17 01:02 mathcass

100% agree, PR welcome! Thanks.

rossant avatar Feb 27 '17 11:02 rossant