Взлетаем!

1 files changed, 36 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4090a38
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# reveal.js презентации Клубов
+
+## Что нужно для использования шаблона?
+
+- just (да, мне понравилось)
+- Python 3
+- UNIX Shell (вендузятники простите)
+- Желательно, браузер с поддержкой Javascript
+
+## Куда класть презентации?
+
+В директорию `presentations`.
+
+## Как их оформлять?
+
+Это описано в презентации `presentations/example.md`. Можно почитать её код, а
+можно и запустить как презентацию.
+
+## Как запускать презентации?
+
+Запускаем команду
+```shell
+just serve <name>
+```
+
+Запустится встроенный в python http сервер. Если порт 8000 уже занят можно
+```shell
+just serve <name> <port>
+```
+
+При этом автоматически сформируется `index.html`. Если нужно получить только его,
+без запуска сервера (например, чтобы захостить на другом сервере), используем
+```shell
+just format <name>
+```
+