214 похожих чатов

Ребят, такой вопрос, в одном из видео автор канала говорил,

что в readme нужно писать только основную инструкцию для настройки окружения. Можно пожалуйста пример какой-нибудь? У нас проект существует уже лет 7-8, а readme пустой, плюс новичкам приходится объяснять всё каждый раз. Мне чисто структуры бы скоммуниздить от куда-нибудь.

8 ответов

18 просмотров

на гитхабе полно примеров. А вообще зависит от проекта. Обычно там есть такие пункты: Требования, установка, использование. Плюс вы можете написать все что лень объяснять новичкам каждый раз

Alex-Ibraimov Автор вопроса
CursedBeing
на гитхабе полно примеров. А вообще зависит от про...

как раз таки все опенсорс проекты пишут совсем другое. Если это либа, то какой нибудь простой пример кода и ссылки на пакеты, ну и какой-нибудь CI/CD

Обычно в ридми оставляют ссылки на документацию и обновления + инструкция по запуску от 0 до рабочего состояния.

обновления в Release notes

Nikolay Desyatkov
screenshot

ого, ридми на русском

Ivan Hranat
ого, ридми на русском

потому что для рускоязычных от рускоязычных

https://github.com/JetBrains/resharper-fsharp

Похожие вопросы

Обсуждают сегодня

Господа, а что сейчас вообще с рынком труда на делфи происходит? Какова ситуация?
Rꙮman Yankꙮvsky
29
А вообще, что может смущать в самой Julia - бы сказал, что нет единого стандартного подхода по многим моментам, поэтому многое выглядит как "хаки" и произвол. Короче говоря, с...
Viktor G.
2
30500 за редактор? )
Владимир
47
а через ESC-код ?
Alexey Kulakov
29
Гайс, вопрос для разносторонее развитых: читаю стрим с юарта, нада выделять с него фреймы с определенной структурой, если ли чо готовое, или долбаться с ринг буффером? нада у...
Vitaly
9
Чёт не понял, я ж правильной функцией воспользовался чтобы вывести отладочную информацию? но что-то она не ловится
notme
18
У меня есть функция где происходит это: write_bit(buffer, 1); write_bit(buffer, 0); write_bit(buffer, 1); write_bit(buffer, 1); write_bit(buffer, 1); w...
~
14
Добрый день! Скажите пожалуйста, а какие программы вы бы рекомендовали написать для того, чтобы научиться управлять памятью? Можно написать динамический массив, можно связный ...
Филипп
7
Недавно Google Project Zero нашёл багу в SQLite с помощью LLM, о чём достаточно было шумно в определённых интернетах, которые сопровождались рассказами, что скоро всех "ибешни...
Alex Sherbakov
5
длина пакета фиксированная, или меняется?
Okhsunrog
7
Карта сайта