cryptoadvocate/dcsgonefwbspДомашняя страница пакета поддержки платы (BSP) прошивки первого проекта электронного бейджа Circuit Crafters.
Чтобы облегчить начало работы с GitLab, вот список рекомендуемых следующих шагов.
Уже профессионал? Просто отредактируйте этот README.md и сделайте его своим. Хотите упростить? Используйте шаблон внизу!
cd existing_repo
git remote add origin https://gitlab.com/cryptoadvocate/dcsgonefwbsp.git
git branch -M main
git push -uf origin main
Используйте встроенную непрерывную интеграцию в GitLab.
Когда вы будете готовы сделать этот README своим, просто отредактируйте этот файл и используйте удобный шаблон ниже (или смело структурируйте его как захотите — это всего лишь отправная точка!). Спасибо makeareadme.com за этот шаблон.
Каждый проект уникален, поэтому подумайте, какие из этих разделов подходят для вашего. Разделы, используемые в шаблоне, являются рекомендациями для большинства проектов с открытым исходным кодом. Также имейте в виду, что хотя README может быть слишком длинным и подробным, лучше слишком длинный, чем слишком короткий. Если вы считаете, что ваш README слишком длинный, рассмотрите возможность использования другой формы документации, а не сокращения информации.
Выберите самоочевидное имя для вашего проекта.
Расскажите людям, что именно может делать ваш проект. Предоставьте контекст и добавьте ссылку на любые справочные материалы, с которыми посетители могут быть незнакомы. Здесь также можно добавить список функций или подраздел «История». Если существуют альтернативы вашему проекту, здесь хорошо перечислить отличительные факторы.
В некоторых README вы можете увидеть небольшие изображения, передающие метаданные, например, проходят ли все тесты для проекта. Вы можете использовать Shields, чтобы добавить такие значки в свой README. Многие сервисы также имеют инструкции по добавлению значка.
В зависимости от того, что вы создаете, может быть хорошей идеей включить скриншоты или даже видео (часто вы увидите GIF-файлы, а не фактические видео). Такие инструменты, как ttygif, могут помочь, но ознакомьтесь с Asciinema для более сложного метода.
В определенной экосистеме может быть распространенный способ установки, например, с использованием Yarn, NuGet или Homebrew. Однако учтите возможность того, что читатель вашего README — новичок и хотел бы получить больше руководства. Перечисление конкретных шагов помогает устранить неоднозначность и позволяет людям как можно быстрее начать использовать ваш проект. Если он работает только в определенной среде, например, в определенной версии языка программирования или операционной системе, или имеет зависимости, которые необходимо устанавливать вручную, также добавьте подраздел «Требования».
Щедро используйте примеры и показывайте ожидаемый результат, если можете. Полезно включить встроенный минимальный пример использования, который вы можете продемонстрировать, предоставляя ссылки на более сложные примеры, если они слишком длинны для разумного включения в README.
Сообщите людям, куда они могут обратиться за помощью. Это может быть любая комбинация трекера проблем, чата, адреса электронной почты и т.д.
Если у вас есть идеи для будущих релизов, хорошей идеей будет перечислить их в README.
Укажите, открыты ли вы для вклада со стороны сообщества и какие у вас требования для его принятия.
Для людей, которые хотят внести изменения в ваш проект, полезно иметь документацию о том, как начать. Возможно, есть скрипт, который они должны запустить, или переменные окружения, которые нужно задать. Сделайте эти шаги явными. Эти инструкции также могут быть полезны вам в будущем.
Вы также можете документировать команды для linting кода или запуска тестов. Эти шаги помогают обеспечить высокое качество кода и снизить вероятность того, что изменения случайно что-то сломают. Наличие инструкций по запуску тестов особенно полезно, если это требует внешней настройки, например, запуска Selenium-сервера для тестирования в браузере.
Выразите признательность тем, кто внес вклад в проект.
Для проектов с открытым исходным кодом укажите, как он лицензирован.
Если у вас закончились силы или время для вашего проекта, поместите заметку в начале README о том, что разработка замедлилась или полностью остановилась. Кто-то может решить форкнуть ваш проект или добровольно стать мейнтейнером или владельцем, что позволит проекту продолжить развитие. Вы также можете сделать явный запрос на мейнтейнеров.