Readme

Что такое Readme.md?

README (буквально означает «прочти меня») — это первый файл, который нужно читать, получив доступ к проекту на Github или любой Git-хостинговой площадке. Этот файл в первую очередь и предлагается вниманию пользователя, когда он открывает здесь репозиторий того или иного проекта. Такой файл содержит кучу полезной информации, так что его вполне можно рассматривать как справочное руководство по проекту.

Файл Readme.md находится в корневой папке репозитория и автоматически отображается в каталоге проекта на github.

Расширение .md — это сокращение от слова markdown. Это язык разметки для форматирования текста. Его используют (как и язык разметки HTML) для нормального отображения документов

Создание краткого описания проекта

Для проекта надо подготовить хорошее описание. При составлении описания можно придерживаться такого плана:

  • название (желательно и его изображение тоже. Отредактировать можно на canva.com, если вы не специалист по графическому дизайну);
  • описание (с использованием слов и изображений);
  • демо (изображения, ссылки на видео, интерактивные демо-ссылки);
  • технологии в проекте;
  • что-то характерное для проекта (проблемы, с которыми пришлось столкнуться, уникальные составляющие проекта);
  • техническое описание проекта (установка, настройка, как помочь проекту).

README (mis tähendab sõna-sõnalt “loe mind”) on esimene fail, mida tuleb lugeda, kui sisened Githubi või mõne muu Git-hostingu saidi projektile. See fail on esimene asi, mida kasutajale tutvustatakse, kui ta avab siin projekti repositooriumi. See fail sisaldab palju kasulikku teavet, seega võib seda pidada projekti viitejuhiks.

Readme.md fail asub repositooriumi juurkaustas ja kuvatakse automaatselt projekti kataloogis githubis.

Laiendus .md on lühend sõnast markdown. See on märgistuskeel teksti vormindamiseks. Seda kasutatakse (nagu HTML-märgistuskeelt) dokumentide korrektseks kuvamiseks.

Projekti lühikirjelduse koostamine

Projektile tuleks koostada hea projekti kirjeldus. Kirjelduse kirjutamisel võite järgida järgmist kava:

pealkiri (soovitavalt ka selle pilt. Kui te ei ole graafilise disaini spetsialist, saate seda redigeerida canva.com'is);
kirjeldus (kasutades sõnu ja pilte);
demo (pildid, videolingid, interaktiivsed demolingid);
projektis kasutatav tehnoloogia;
midagi konkreetset projekti kohta (tekkinud probleemid, projekti ainulaadsed komponendid);
projekti tehniline kirjeldus (paigaldamine, kohandamine, kuidas projekti aidata).