что в readme нужно писать только основную инструкцию для настройки окружения. Можно пожалуйста пример какой-нибудь? У нас проект существует уже лет 7-8, а readme пустой, плюс новичкам приходится объяснять всё каждый раз. Мне чисто структуры бы скоммуниздить от куда-нибудь.
на гитхабе полно примеров. А вообще зависит от проекта. Обычно там есть такие пункты: Требования, установка, использование. Плюс вы можете написать все что лень объяснять новичкам каждый раз
как раз таки все опенсорс проекты пишут совсем другое. Если это либа, то какой нибудь простой пример кода и ссылки на пакеты, ну и какой-нибудь CI/CD
Обычно в ридми оставляют ссылки на документацию и обновления + инструкция по запуску от 0 до рабочего состояния.
обновления в Release notes
ого, ридми на русском
потому что для рускоязычных от рускоязычных
https://github.com/JetBrains/resharper-fsharp
Обсуждают сегодня