From 7bf0d66f6059beeef8343ca5b2290c2a301e41a3 Mon Sep 17 00:00:00 2001 From: Christian Krause <christian.krause@idiv.de> Date: Fri, 12 Oct 2018 11:11:56 +0200 Subject: [PATCH] adds local viewing usage to readme --- README.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 53f63a3..dd75585 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,32 @@ -# The Official iDiv git Seminar +# The Official iDiv git Seminars ## Usage -- update reveal.js submodule -- run make to create svg from dot sources +To view the presentations locally, you need to clone the repository +recursively, to also get a copy of [reveal.js][]: + +```bash +git clone --recursive https://git.idiv.de/sc/edu/git-seminar.git +``` + +Then you also need to create the images from the [graphviz dot +sources][graphviz]: + +```bash +cd git-seminar +make +``` + +Then you can view the presentations, e.g. the basics: + +``` +firefox basics.html +``` ## Attribution - git logo by [Jason Long](https://twitter.com/jasonlong) + + +[graphviz]: http://www.graphviz.org/ +[reveal.js]: https://revealjs.com/#/ -- GitLab