diff --git a/README.md b/README.md new file mode 100644 index 0000000..3ed93ca --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +# Процедура внесения изменений в документацию + +1. Склонировать репозиторий. +2. При редактировании репозитория, изменения вносить в формате MarkDown, в файлах, расположеных по пути ```src/ru/src``` +3. После внесения изменений, протестировать выполнение сборки документации при помощи команды ```mdbook build``` +4. MdBook можно установить из реестра пакетов Rust: ```cargo install mdbook``` +5. Закоммитить и запушить в репозиторий. +6. Изменения будут доступны в https://docs.selfprivacy.org \ No newline at end of file