diff --git a/README.md b/README.md index 4371fee..38eb870 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,42 @@ # Alex Presentations -Here you'l find various presentations done with Revealjs or any new shiny tool I've found. + +Here you'l find various presentations done with Revealjs or any new shiny tool I've found. +Currently, small adjustments were made to provide a to the reveal.js submodule all the configuration needed to serve files located in the parent folder. + +# Usage + +## Writing your slide + +- Use the reveal.js `index.html` template located in the submodule. +- You can see your presentation by going to the `index.html` file with ~~Firefox~~ your favorite browser +- Remember to set the correct path to plugins eg. `custom_plugins/my_super_plugin/plugin.js` + +## Gitlab CI/CD + +A sample `.gitlab-ci.yml` is provided, currently (and quite dirtily FTM) providing a way to: + +- Generate a PDF from `index.html` via [decktape](https://github.com/astefanutti/decktape) (containerized) +- Generate a Powerpoint (.pptx) file via [linuxserver/libreoffice](https://hub.docker.com/r/linuxserver/libreoffice) (containerized) +- A job to prepare all of this +- Serve said presentation/files via Gitlab Pages. + +## URLs + +Didn't tested anywhere else but it should be: +https://.gitlab.io//[/slide.{pptx,pdf}]. +For example: +https://john-doe.gitlab.io/alex-presentations/make/notion/ + +## TODO + +- Better CI, currently jobs are manual only +- Cleaner code +- Better templating +- Auto-upload to google-drive +- PDF/PPTX/Pages CI when tag +- ~~Find a cure to earth's suffering~~ + +## Disclaimer + +Yeah, it's dirty, could be better, not optimal, yadah yadah. +Will try to do better, don't roast me too much :)