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.

Sign up for GitHub

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

Jump to bottom

convert README to .rst #53

Closed
steven-esser opened this issue Feb 5, 2018 · 1 comment
Closed

convert README to .rst #53

steven-esser opened this issue Feb 5, 2018 · 1 comment
Assignees
@johnmhoran

Comments

@steven-esser
Copy link
Contributor

steven-esser commented Feb 5, 2018 •
edited
Loading

Currently our README is in markdown form.

In order to conform with nexB + pypi standards, our README file should be .rst or re-structured text.

The doc is simple enough to edit manually, but there are also automated options: http://avilpage.com/2014/11/pandoc-best-way-to-convert-markdown-to.html
johnmhoran added a commit that referenced this issue Feb 6, 2018
@johnmhoran
Convert README to .rst #53
2010f21 
Signed-off-by: John M. Horan <johnmhoran@gmail.com>
steven-esser added a commit that referenced this issue Feb 6, 2018
@steven-esser
Fix codeblock formatting #53
73fcc93 
Signed-off-by: Steven Esser <sesser@nexb.com>
steven-esser added a commit that referenced this issue Feb 6, 2018
@steven-esser
Update MANIFEST files to reflect new filename #53
95391f4 
Signed-off-by: Steven Esser <sesser@nexb.com>
@steven-esser
Copy link
Contributor Author

#56 merged, closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@johnmhoran johnmhoran

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@steven-esser @johnmhoran