Readme

Have I mentioned that I love GitHub?

When you put a readme file into a folder that file is formatted and presented nicely through GitHub’s file browser. For example:

https://github.com/visionmedia/uikit

Scrolling down a little we can see a nicely formatted readme file.

GitHub strongly recommends adding a readme file to the root of your repository, but what I didn’t realise until recently was that it works for any folder in your repo. GitHub already has the best online file browser out there, but this specific feature can turn your source tree into your documentation.

For Robotlegs 2 I decided to try it out:

Async
MessageDispatcher
Extensions

Almost every package in the entire repo has a readme file. The best way to learn about Robotlegs 2 is to browse the source and readme files on GitHub.

Posted in Banter, Code, Resources, Robotlegs, Tutorials | Tagged , , | 2 Comments
  • http://www.kensodev.com/ Avi Tzurel

    Projects with an awesome README have better chances to be watched forked and same with community involvement.

    Github makes your README really shine.

    Kudos on your README’s…

  • http://shaun.boyblack.co.za/blog/ shaun

    Indeed! Thanks Avi :)