Convert the README to rst#20
Conversation
|
Thanks for the pull request Christopher. This looks good to me. @definite Could you please review this and merge if you agree? |
|
In the rendered preview, all the command samples ("code") seem to be in |
|
@cjbayliss Perhaps the indented code doesn't need to be surrounded with "``"? (Not sure of my RST, but I'm assuming it's somewhat similar to markdown in this respect.) |
|
I think what I suggested above will work, if the preceding paragraphs end in two colons, like this:: |
|
Yep, that works better, I'll make the change now. |
|
Anyone wanting to see the preview, see here: https://github.com/cjbayliss/zanata-python-client/blob/master/README.rst |
|
@definite Are you happy with the changes? |
|
I generally prefer markdown to RST, but RST probably makes sense for a Python project, and it wouldn't be difficult to convert the formatting from .rst to .md if we need to. |
|
Yep. I should learn markdown, I just do RST because that is what we use at Cyber IT Solutions. :) |
|
Looks like the I think we'll just have to live with it. |
|
The rest looks fine to me. |
|
I have made that change, I don't know if there are more like that because I don't use Zanata myself. It is probably worth getting someone to got through this README and fix up that sort of stuff. I only converted the README from what it was to rst. :) |
Convert the README to rst @cjbayliss Thanks!
|
Thanks for the contribution, @cjbayliss . |
|
No problem! :) |
I found it a little hard to read the README on github, so I converted it to reStructuredText.
I also fixed some spelling and grammar.