diff --git a/README.md b/README.md index ac3b481..8938bf2 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,24 @@ # 🎓 [AGH](https://www.agh.edu.pl/en) slide deck for [Quarto](https://quarto.org/docs/presentations/)/Jupyter/Python 🐍 -This repo provides a single Jupyter/Python notebook file which can get you started with authoring a reproducible +💡 This repo provides a single Jupyter/Python notebook file which can get you started with authoring a reproducible presentation in a template themed following [AGH University of Krakow](https://www.agh.edu.pl/en/) [visual identity](https://www.agh.edu.pl/en/university/multimedia/graphic-symbol) and [logo usage](https://www.agh.edu.pl/en/o-agh/multimedia/znak-graficzny-agh/znak-graficzny-bez-nazwy) guidelines. -It allows to tightly couple the code generating all figures and values in the slides with other presentation content + +👩💻 It allows to tightly couple the code generating all figures and values in the slides with other presentation content enabling you (or others) to recreate everything with a single `quarto render ...` command, ensuring that slide contents are by-design in sync with the code, in the spirit of "reproducible manuscripts" approach (see, e.g., [Perkel 2022, Nature](https://doi.org/10.1038/d41586-022-00563-z)). -In addition, the sample notebook includes BibTeX-format bibliography catalogue set up to automatically - render `[@label]` references as slide footnotes. +📚 In addition, the sample notebook includes BibTeX-format bibliography setup which automatically + adds reference footnotes for slides with `[@label]` citations. -## How to use it? +## 🧭 How to use it? -To use it, grab the [example `.ipynb` file](https://github.com/habemus-python/quarto-agh-slides/blob/main/slides.ipynb) and edit it +📝 To use it, grab the [example `.ipynb` file](https://github.com/habemus-python/quarto-agh-slides/blob/main/slides.ipynb) and edit it with your favourite Jupyter notebook tool. -To generate HTML files for presentation, do `quarto render slides.ipynb --execute --to revealjs`, the output (`slides.html` file) should look like this: +🌐 To generate HTML files for presentation, do `quarto render slides.ipynb --execute --to revealjs`, the output (`slides.html` file) should look like this: