rtfd

Создайте и читайте эксклюзивные документы.

Зависимости

rtfd поддерживает только операционную систему Linux!

Для запуска скрипта сборки требуется среда выполнения bash, команды git, а также среды Python 2.7 и Python 3.6+ (с установленными pip и virtualenv). Также необходим сервис nginx.

Кроме того, требуется зависимость от внешнего сервиса redis. Если вы используете функции GitHub App, вам потребуется доступ к API GitHub.

Установка

Использование скомпилированного исполняемого файла

version=1.3.3
wget -c https://github.com/staugur/rtfd/releases/download/v${version}/rtfd.${version}-linux-amd64.tar.gz
tar zxf rtfd.${version}-linux-amd64.tar.gz
mv rtfd ~/bin/
rtfd -v

Компиляция из исходного кода для установки последней версии

1. Установите среду разработки golang версии 1.16 или выше.

2. Соберите и установите (можно использовать один из двух способов):

   2.1 Скачайте исходный код и соберите:

   git clone https://github.com/staugur/rtfd && cd rtfd
   make build
   mv bin/rtfd ~/bin
   rtfd -v

   2.2 Используйте команду go get:

   go get -u tcw.im/rtfd      # Можно использовать @tag для установки определённой версии, например @v1.3.3
   mv ~/go/bih/rtfd ~/bin/
   rtfd -v

Использование

rtfd --init
rtfd p create --url {git-url} --other-options {ProjectName}
rtfd build {ProjectName}

Дополнительные опции доступны с опцией --help / -h.

Документация

Дополнительную информацию см. в подробной документации.