TLDR: I was introduced to Markdown on this forum. I think it works well here and on GitHub, but I am wondering how convenient it is for general-purpose offline use.
I like to include a README.txt inside any folders that require some explanation. These could be simulations, experimental results, code, etc. I was excited to start creating README.md instead of README.txt going forward because the formatting options make it much more readable, but I ran into some friction:
- No default application on Windows when you double-click on a markdown file from File Explorer.
- Different rendering behavior based on client application.
a. VSCode only opens the plain text version by default. Then you have to know the “Open Preview” button exists and find it from the context menu.
a. VSCode won’t respect
<Enter>as a newline. It requires
"<br>"which looks bad in plain text form.
a. Sometimes need to install extensions for certain elements to render correctly like math, tables, and file links.
a. Limited options for ordered lists.
For the reasons above, I am wondering if I am better off writing a README.doc instead. Everyone already has a word processor installed, and they all support Microsoft Word format now. Plus there won’t be any rendering surprises that way. What do you think has the best balance of portability and features? I want to maximize the ease of knowledge transfer for anyone that comes across my files.
.txt is easy to open but hard to read.