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

Update Project README to support markdown #6

Closed
claudijd opened this issue Nov 5, 2013 · 1 comment
Closed

Update Project README to support markdown #6

claudijd opened this issue Nov 5, 2013 · 1 comment

Comments

@claudijd
Copy link
Collaborator

claudijd commented Nov 5, 2013

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.

@royhills
Copy link
Owner

royhills commented Nov 6, 2013

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.

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

2 participants