alinebee / Boxer

The DOS game emulator that's fit for your Mac.
http://boxerapp.com/
770 stars 139 forks source link

Markdown-ified the readme file #35

Closed jodelamo closed 10 years ago

jodelamo commented 10 years ago

Converted the readme into markdown. Looks prettier on GitHub. :)

alinebee commented 10 years ago

Thanks for this, that does look much better! However before I merge, is there any way to get the benefits of markdown parsing on github without the dippy file extension? This is an issue because .md files have no default file association on OS X, so people opening it from Finder will have to jump through hoops in order to view it.

jodelamo commented 10 years ago

It does indeed require some form of application capable of parsing the format to see it in all its glory. People pulling the project from GitHub should be fairly accustomed to markdown however, considering its widespread use.

The only solution I know of is to include both a Readme.txt and Readme.md. In such a case GitHub would prefer the markdown file over the generic text file.

alinebee commented 10 years ago

True enough. I'll think about re-adding a text version if anyone asks.