diff --git a/README.md b/README.md index 53f63a33098494709b262c6f1e4ab01f56a3d718..dd755850cc1e5beba61e2831410d1959f69b9b57 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/#/