Используйте autotools с README.md

Я использую autotools для библиотек, размещенных на GitHub. Вместо обычного обычного текстового файла README я хочу использовать README.md.

При запуске automake я получаю следующую ошибку

Makefile.am: required file `./README' not found

Можно ли отключить autotools для проверки README?

Ответ 1

Просто передайте параметр foreign для automake. Это говорит о том, что ваше программное обеспечение не соответствует типичным стандартам gnu, и, таким образом, отказ от README не является ошибкой. Как правило, это делается в configure.ac:

AM_INIT_AUTOMAKE([foreign])

но это также можно сделать, назначив AUTOMAKE_OPTIONS в Makefile.am:

AUTOMAKE_OPTIONS = foreign

Ответ 2

Мы используем

README: README.md
        fgrep -v "[Build Status]" $< \
                | markdown \
                | html2text -style pretty -nobs \
                | sed -e 's:&gt;:>:g' \
                > [email protected]

для создания текста README из уценки README.md

Ответ 3

Почему бы вам не искать ваш файл README, если у вас его уже есть? Это просто происходит в формате уценки и сохраняется как README.md. Если вы хотите, чтобы ваш файл README был идентичен файлу README.md, почему бы не ссылаться на него?

Из командной строки:

ln -s README.md README

Таким образом, вы сохраните файл README.md, и любые инструменты, которые вы используете, по-прежнему смогут работать со стандартными соглашениями об именах. Скорее всего, очень вероятно, что autotools позволяет указать настраиваемый путь для вашего readme.

Ответ 4

Решение на основе pn fceller: единственное, что необходимо, - это правило сборки для README в makefile.am. Это правило может быть пустым. Поэтому просто добавьте следующую строку в makefile.am:

README: README.md

Что все, теперь automake больше не жалуется, и вам не нужно объявлять ваш проект как foreign.

Это не нужно, но я предпочитаю более полное правило, добавляю к makefile.am:

README: README.md
    pandoc -f markdown -t plain --wrap=none $< -o [email protected]

CLEANFILES = README

Но даже с этим правилом README не создается, если вы явно не назовете make README.