Improve the README Generator

barbagroup / JITcode-MechE

Online learning modules to learn computing in a problem-based context within Mechanical Engineering

MIT License

7 stars 5 forks source link

Improve the README Generator #5

Closed ahmadia closed 10 years ago

ahmadia commented 10 years ago

[x] Document this slightly better so new developers understand what it does.
[x] Be able to put underscores in file names and have them turned into spaces.

e.g. Python_Intro -> Python Intro

labarba commented 10 years ago

agolding718 commented 10 years ago

:+1:

ahmadia commented 10 years ago

GitHub emoji -> :+1:

AdaWick commented 10 years ago

:+1:

gforsyth commented 10 years ago

Added some reasonably robust documentation to the gen-readme script and also added the underscore -> space functionality.
The regex that takes care of that is a little bit hairy if anyone want to improve it, but it gets the job done.

ahmadia commented 10 years ago

Cool, looks like this happened in: https://github.com/barbagroup/JITcode-MechE/commit/83902774817671b14dbe2c9b64c405963c6c163c