Как писать файлы README как профессионал
Существует острая необходимость в правильном файле README в каждом проекте, над которым вы работаете. Здесь должна содержаться очень основная, но ключевая информация о проектах, но не только это. Хороший README получается, если в нем содержится немного больше, чем основная информация о проекте. Что именно? Мы рассмотрим это в этом документе.
Целевая аудитория этого поста — новички, которым еще предстоит поверить в силу документации. Кроме того, мой опыт здесь в основном имеет отношение к моей работе - поэтому веб-приложения, в зависимости от приложения, могут различаться, однако я думаю, что приведенный ниже совет является хорошим началом.
https://shly.link/devEyxS
Post #310
428