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

Generate plaintext README #5

Open
israel-lugo opened this issue Jun 11, 2016 · 0 comments
Open

Generate plaintext README #5

israel-lugo opened this issue Jun 11, 2016 · 0 comments

Comments

@israel-lugo
Copy link
Owner

README.md looks nice in Github, but it's not practical for users who download our code, or install the package.

A README.txt can be generated using pandoc:
pandoc -t plain -f markdown README.md > README.txt

But this doesn't support all formatting. Namely, it doesn't support HTML <sup> tags, which we use to represent 264, leaving us with "1 in 264" instead of "1 in 264". And that's just not the same thing.

We could change to AsciiDoc. That supports superscripting natively.

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

1 participant