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
I didn't realise github supported a markup language for the README file. It certainly makes the project look much better, and I think it would be a good thing to do.
The only things to consider are whether it's best to have a separate README.md and README. Automake likes to see a file called README, but I guess github needs the .md extension to render the markup correctly. It would probably be easy to have a makefile rule to generate the text file from the markdown one sed or grep though.
But, yes, let's do it. Markdown formatted readme's look much better than plain text ones.
I was thinking we could migrate the README or provide another file README.md to support a more dynamic readme for new users.
One of the side benefits of this would be that the markdown can be used to demonstrate the existing travis build status.
Here's an example from one of my ruby project so you can see an example:
https://github.com/claudijd/c7decrypt
If you're interested in doing something like this, I'd be willing to produce a pull request for this.
The text was updated successfully, but these errors were encountered: