Hej, chciałem wysłać swój kod do oceny do firmy, w której chciałbym pracować i teraz mam takie pytanie wrzuciłem kod na github-a i teraz nie wiem co powinienem umieścić w pliku Readme, jakiś opis jak aplikacja działa? Kiedy ją robiłem ?
Z góry dzięki za wszelkie sugestie!
Użyj markdownu -> https://help.github.com/articles/basic-writing-and-formatting-syntax/
Bardziej dla bibliotek, niż dla programów widocznych dla rekruterów, ale może się przydać: http://rowanmanning.com/posts/writing-a-friendly-readme/
Do tego co napisał @Maciej Cąderek dodaj jeszcze informacje o licencji (jeżeli takową repozytorium ma). Jeżeli jest to API, albo jakaś pomniejsza biblioteka, to warto też przedstawić przykład jej zastosowania.