Слияние кода завершено, страница обновится автоматически
В начале файла должна быть короткая вводная информация и/или обзор, который объясняет что такое проект. Это описание должно совпадать с описанием, добавленным для менеджеров пакетов (Gemspec, package.json и т.д.).
Показывайте, как работает библиотека максимально кратко, чтобы разработчики могли понять как ваш проект решает их проблему, просто взглянув на пример кода. Убедитесь, что API, которое вы демонстрируете, очевидно, а сам код краток и лаконичен.
Короткое описание мотивации за создание и поддержку проекта. Это должно объяснить почему существует данный проект.
Укажите, как установить проект, предоставляя примеры кода.
В зависимости от размера проекта, если он достаточно мал и простой, справочные документы могут быть добавлены непосредственно в README. Для более крупных проектов важно предоставить ссылку на место, где находятся справочные документы API.
Опишите и покажите, как запустить тесты, используя примеры кода.
Дайте людям знать, как они могут приступить к работе над проектом, указав важные ссылки на такие вещи, как трекеры ошибок, IRC, аккаунты Twitter, если применимо.
Короткий фрагмент, описывающий лицензию (MIT, Apache и т.д.).
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Комментарии ( 0 )