Не понимая, как загрузить мой код с помощью внешних библиотек - PullRequest
0 голосов
/ 09 июля 2019

Я работаю над скриптом визуализации музыки на python. Я использую аудио-библиотеку под названием Aubio. Если я загружу свой код на такой сайт, как Github, как я могу сделать скрипт доступным для всех? Нужно ли включать библиотеку в код? Должен ли я просто объяснить в файле readme, что библиотека требуется или что решение может быть добавлено непосредственно к исходному коду?

1 Ответ

0 голосов
/ 09 июля 2019

Лучше всего документировать зависимость: что это, если требуется определенная версия, если она работает только на некоторых системах, как ее установить, если есть дополнительная конфигурация.Преимущество открытого исходного кода или, по крайней мере, совместного использования кода, состоит в том, что если настройка aubio вводит в заблуждение кого-то, он может сказать вам, и вы можете добавить более подробную информацию в свой README.

Включение библиотеки в вашкод, который я считаю означающим проверку исходного кода вашей зависимости в вашем репо, следует избегать.Многие проекты создают файл с именем .gitignore, который по умолчанию игнорирует такие каталоги (deps/, node_modules/).Регистрация aubio in заблокирует вас от обновлений в кодовой базе, побудит людей редактировать этот код, когда они не должны, и добавит ненужный размер к вашему репо.

...