Skip to content

iakov/riscv-courses

Folders and files

NameName
Last commit message
Last commit date

Latest commit

9bd957e · Dec 25, 2023

History

29 Commits
Jul 17, 2023
Dec 25, 2023
Dec 6, 2023
Sep 16, 2023
Jun 13, 2023
Jul 24, 2023
Sep 16, 2023
Apr 17, 2023
Sep 16, 2023

Repository files navigation

В данном репозитории находятся переводы курсов

Сборка артефактов курсов

Для сборки .pdf из .adoc файлов используется asciidoctor-pdf.

Если asciidoctor-pdf не установлен локально, можно воспользоваться Docker-образом asciidoctor/docker-asciidoctor. Тогда все описанные ниже команды можно выполнить в Docker-контейнере так:

docker run --rm \
    --user="$(id -u):$(id -g)" \
    -v "$(pwd)":/documents/ \
    asciidoctor/docker-asciidoctor <команда>

Чтобы выполнить сборку текста курса, необходимо запустить скрипт ./scripts/build_course.sh, передав ему имя собираемого курса. Команда

./scripts/build_course.sh LFD113x-RU

выполнит сборку файла Course.pdf в директории с курсом (./LFD113x-RU)

Чтобы задать имя создаваемого файла используется опция (-o или --out)

./scripts/build_course.sh --out LFD113x_RU LFD113x-RU

Добавление нового курса

Каждый курс лежит в папке с именем, задающем его название (рекомендуется использовать код курса).

В папке должен быть Makefile для сборки артефактов. Сборка должна осуществляться целью по умолчанию. Также должна быть возможность переопределить переменную RESULT_PDF при вызове (используется скриптом ./scripts/build_course.sh). Пример — LFD113x-RU/Makefile

Также для курса необходимо добавить строку с его описанием в файл Courses.csv. В этой строке должны быть имя курса, имя собранного файла (рекомендуется использование только символов ASCII) и текст для отображения в релизе GitHub, разделённые запятыми.

Пример:

LFD113x-RU,RISC-V_Toolchain_and_Compiler_Optimization_Techniques_LFD113x_RU,Инструментарий и компиляторные оптимизации для RISC-V (LFD113x) RU