19 May '13, 9pm

There is a science and an art to writing an effective README for an open source project.

May 19, 2013 calebjthompson writing readme github How to write a README Leadership is often defined as having the ability to make others want to do what it is that you would like them to do. You want people to want to use your software, and often their first introduction will be through the README on the GitHub project. There are of course components to a technical document that make it more effective. Describe what it is that your project makes easier. Provide code examples detailing how the use of the library. Document the installation process. These are the basic elements which define a README. Creating a great face for your project, however, requires still more. Don’t get lazy just because this is for developers Technical writing is still writing, and need not be dry and boring. Just as if you were writing an essay or blog post, you should strive to grab the attention ...

Full article: http://robots.thoughtbot.com/post/50852570430/how-to-writ...

Tweets

How to write a great README

robots.thoughtbot.com 20 May '13, 5am

May 19, 2013 calebjthompson writing readme open source How to write a great README Leadership is often defined as having t...

Neat! Decent Exposure makes it easier to write concise controllers:

Neat! Decent Exposure makes it easier to write ...

asciicasts.com 19 May '13, 4pm

In this episode we’re going to look at a gem called decent_exposure . This is a simple gem with a nice concept. We can use...

Rubyflow Writing a good README: New blog on wri...

rubyflow.com 07 May '13, 3am

Writing a good README Posted by xfitzyx on May 07, 2013 — 0 comments New blog on writing a good README for Rails projects ...

Bitcoin developer talks regulation, open source...

pcworld.com 19 May '13, 7pm

A Bitcoin core developer for three years, he left his job at Red Hat on Friday to start work at Bitpay, the biggest Bitcoi...

Bitcoin developer talks regulation, open source...

pcworld.com 19 May '13, 7pm

A Bitcoin core developer for three years, he left his job at Red Hat on Friday to start work at Bitpay, the biggest Bitcoi...

Why do we still question why we write tests? – ...

smartic.us 23 May '13, 6am

Maybe it’s not the Why that I’d like to debate, but I sure wish people thought more about the When and the How. I’d say Wh...