Ohjeet README.md -tiedoston päivittämiseen

README.md on GitHub-projekteissa oleva tiedosto, johon on tarkoitus päivittää projektin perustiedot. Ne kannattaa päivittää myös kaikkiin tuleviin projekteihin, jotka tulette laittamaan itse GitHubiin. README.md toimii markdown-merkintätavalla, jonka käytännöt voi tarkistaa täältä.

README.md sisältää vähintään seuraavat asiat, mutta niitä voi olla enemmänkin:

1. Projektin nimi
2. Projektitiimiläiset ja heidän roolinsa
3. Projektin kuvaus ja tarkoitus
4. Projektiin käytettävät teknologiat
5. Miten projektin voi saada toimimaan itselleen (ns asennusohjeet, joskaan tässä vaiheessa ohjeita on aika vähän)

Jokainen kohta kuuluu kirjoittaa selkeillä kokonaisilla lauseilla, jos kyse ei ole listasta, ja mielellään englanniksi. README.md:ssä voi olla kuvattuna myös projektin rakennekaavio ja muita asioita. Kun dokumentin pituus kasvaa, kannattaa siihen tehdä myös sisällysluettelo, mutta tässä dokumentissa pituus tuskin tulee ongelmaksi.