search

kleintom / Cstitch

Convert images to cross stitch patterns: choose the number of colors to use and the final pattern size; edit your pattern (save and restore your work); save your pattern as a pdf.
http://cstitch.sourceforge.net/
GNU General Public License v3.0
35 stars 12 forks source link

Create readme in main directory #3

Closed edunham closed 10 years ago

edunham commented 10 years ago

When GitHub finds a markdown-formatted readme file, it displays it on the front page of the project. Adding this file means that users accustomed to GitHub workflow are likelier to find the project's documentation when glancing at it, since this is the location where one expects to find that information.

I know this because I didn't find the "real" documentation till my third day trying to use the project, because I automatically assumed a project on github would have a link to its docs in the readme, whereas your docs link was hiding in plain site in the project description... :persevere:

kleintom commented 10 years ago

I rewrote the old README as markdown and moved it to the main directory. Thanks!