такое, накидать пару кратких примеров вдобавок к тем, что есть в отдельной папке, вынести в отдельный док инструкции по установке (пока я в pypi это все не залил)... больше ничего в голову не приходит
Не знаю, как другие, а я в readme ожидаю полное описание всего API библиотеки. Каждый метод с коротким примером, относящийся именно к методу. Разбирать огромную простыню в файле с примером буду только от безысходности, если других библиотек нет.
Представь ситуацию, когда ты купил сложный прибор без инструкции. Будешь ли ты доволен тратить время на выяснение того, что можно было бы просто прочитать. Вот там должно быть все, чтобы понять что это, как этим пользоваться и зачем это вообще нужно. Маркетинг никто не отменял
Обсуждают сегодня