maxhdekker / minesweeper Goto Github PK

Je hebt feedback gekregen van BerendWeij
URL: https://github.com/MaxHDekker/MineSweeper/blob/master/README.md

Feedback: Je pagina bevat al netjes bewegend beeld.

Let even op taalfouten. Verder moet in de beschrijving duidelijk zijn:

voor welk platform je het hebt gemaakt
in welke taal je het hebt gemaakt
wat er speciaal is aan dit project (keywords)

Maar de demo ziet er prima uit.

Je hebt feedback gekregen van BerendWeij
op:

# MineSweeper
MineSweeper code Max Dekker GD3B
 

URL: https://github.com/MaxHDekker/MineSweeper/blob/master/README.md

Feedback: Zorg dat er een korte beschrijving van je project (wat is het? Voor welk platform? Met wie?) in je GITHub repository ReadMe staat. Als een stagebedrijf door je GITHub account heengaat dan is het gelijk een stuk duidelijker naar welke repository ze kijken.

Daarnaast gaan ze niet al je scripts doorlopen. Zet in je Readme een aantal links naar scriptbestanden in je repository die de moeite waard zijn om even te bekijken. Stukken code die er uitspringen omdat ze netjes geschreven zijn, omdat het mooie algoritmes zijn, etc. Maak hier echt gebruik van. Dit zijn pluspunten.

Let er trouwens op dat je in een readme kunt werken met Markdown. Dit is een opmaak taal.

Je kunt ook een online editor gebruiken om je readme eerst op te maken met markdown: dillinger.io

Specifieke markdown voor GitHub: https://help.github.com/articles/github-flavored-markdown/

Markdown ondersteunt 'bold tekst', tabellen, headers, etc. Google even op de syntax.