You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.
The text was updated successfully, but these errors were encountered: