20 May '13, 5am

How to write a great README

May 19, 2013 calebjthompson writing readme open source How to write a great 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 in the source code or on the project’s GitHub page. The Basics 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 ...

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

Tweets

There is a science and an art to writing an eff...

robots.thoughtbot.com 19 May '13, 9pm

May 19, 2013 calebjthompson writing readme github How to write a README Leadership is often defined as having the ability ...

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...

Early Bird Registration for Great Eastern Women's Run 2013 Opens

Early Bird Registration for Great Eastern Women...

superadrianme.com 21 May '13, 4am

The Great Eastern Women’s Run is back this year on 10 November 2013. The race will take participants through iconic landma...

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...

From miyagi.sg: Shanghai Is Still In China (And Singapore Airlines Is A Great Way To Fly)

From miyagi.sg: Shanghai Is Still In China (And...

miyagi.sg 20 May '13, 3pm

On a work trip to Shang­hai last Fri­day, I sat in my cab and mar­velled at the gleam­ing tow­ers, giant bill­boards and t...

8 Great Tools to use with Google Analytics

8 Great Tools to use with Google Analytics

seoptimise.com 24 May '13, 3pm

We hear so much about great SEO tools that we should be using, but we rarely see much written about tools to help you with...

GEOX Great Singapore Sale 2013 #geox #gss2013

GEOX Great Singapore Sale 2013 #geox #gss2013

livinginsingaporetoday.com 22 May '13, 5am

Promotion : GEOX Great Singapore Sale 2013 Location: Centrepoint, Great World City, ION Orchard, Marina Square, Paragon, R...

What product is great for daily use on shower w...

greenbuildingadvisor.com 19 May '13, 10am

What product is great for daily use on shower walls that are Ceramic tile to reduce soap scum build up and mildew?

9 Tips to Write Effective Google AdWords Copy ☛...

searchenginejournal.com 26 May '13, 9pm

: Advertisers often try to make their Ad copies very creative. But sadly very few of them do well in terms of Click-throug...

A great idea worth spreading! @karencheng mixes fitness with motherhood: #Perth

A great idea worth spreading! @karencheng mixes...

karencheng.com.au 20 May '13, 11am

I have not been cycling for a few weeks now. It’s driving me a bit crazy, but with my mummy duties and my work piling up, ...

Windows Project | Emila Yusof; draw, write, travel.

Windows Project | Emila Yusof; draw, write, tra...

emilayusof.com 12 May '13, 5am

I love windows and I have huge collection of windows from my travel. A friend told me that I should come up with an illust...