[Code/Docs] Write a README

Tasks for the Jack Claw project.
alt_turo
Posts: 195
Joined: Mon Dec 13, 2010 11:06 am

[Code/Docs] Write a README

Postby alt_turo » Tue May 24, 2011 12:19 pm

Github complains there's no README. Write one.

Description:
README should contain build instructions and where to get the data files. List supported platforms/compilers.
List required libraries.

Why:
So new contributors have some place to look for build instructions.

When:
First thing.

Special skills:
You can write readable documentation.
Turo Lamminen
Alternative Games

Return to “Jack Claw tasks”

Who is online

Users browsing this forum: No registered users and 4 guests