Skip to content

Commit

Permalink
Updates README with content tips
Browse files Browse the repository at this point in the history
  • Loading branch information
tinuola committed Feb 8, 2023
1 parent b9ce480 commit f951609
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

Our slides are powered by [Reveal.js](https://revealjs.com/), the popular HTML presentation framework. For simplicity and ease of use, the Reveal.js files are served via CDN.


## Usage Instructions

- Clone or duplicate the contents of this repo.
Expand All @@ -28,9 +29,18 @@ Our slides are powered by [Reveal.js](https://revealjs.com/), the popular HTML p

- Need/Want to use custom CSS? Add the code to the `style.css` file.

**Recommended:** Preserve the `demo-gdi-slides.html` and `template_` files. Use them as reference/style guide.


## Course Creation Tips
- We recommend using unstacked slides (rather than nested slides) for better readability.

- Limit the amount of content added to each slide. An image, a sentence, or a short code sample are much more understandable than a long list of bullet points.

- Prefer visual explanations to text where possible.

- Add "teachers' notes" such as FAQs, class management tips/best practices to the course `README.md` that can help future instructors.

**Recommended:** Preserve the `demo-gdi-slides.html` and `template_` files. Use them as reference/style guide.

### Slide Markup
Markup heirarchy needs to be ``<div class="reveal"> <div class="slides"> <section>`` where the ``<section>`` represents one slide and can be repeated indefinitely.
Expand Down

0 comments on commit f951609

Please sign in to comment.