Доброго утра, подписчикам нашего канала. Сегодня мы расскажем вам о базовых правилах оформления репозитория на GitHub.
Первый пункт в нашем оформлении - Название, его мы оформляем в видел заголовка с #. Далее, нам нужно указать цели проекта, лучше всего это оформить в виде списка, тк он лучше отображает задачи, и к тому же более адаптирован для метрик. Также можем добавить актуальность нашего проекта.
Вторым пунктом указываем использованные технологии, тут мы можем их просто перечислить, оформить в список, или же как в одном из предыдущих постов сделать красивые плашки с иконками. Все на ваш вкус.
Третье, оформляем принцип работы, тут нам нужно разместить функции нашего софта, а также вкратце описать как реализованы эти самые функции.
Чертвертым пунктом разместим установку. Нередко этот процесс вызывает трудности, поэтому оформить его стоит максимально четко, используйте оформление кода(сделать это можно расставив "' ' '" в начале и в конце кода), добавляйте скриншоты описание.
Сюда же можем добавить пример использования, работы с консолью, также можете прикреплять скрины.
На последок можем написать о владе других участников, или оставить свои контакты.
Надеюсь пост вам помог, напишите в комментариях, что бы вы хотели увидеть в следующий раз!