Adapt readme

andreasKroepelin · Apr 16, 2023 · 55d71d7 · 55d71d7
1 parent 074431a
commit 55d71d7
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -21,31 +21,44 @@ This is a template for creating slides in [Typst](https://typst.app/).
 
 #slide(title: "A boring static slide")[
   Some boring static text.
+
+  #lorem(20)
 ]
 
 #slide[
   A fancy dynamic slide without a title.
-  More text.
-  #only(2)[This appears later!]
+  #uncover("2-")[This appears later!]
 ]
-```
-As you can see, creating slides is as simple as using the `#slide` function.
-(You do not need to care about stuff like `#new-section` or `#only` in the
-beginning.)
 
+#slide(theme-variant: "wake up")[
+  Focus!
+]
+
+#new-section("Conclusion")
+
+#slide(title: "Take home message")[
+  Read the book!
+
+  Try it out!
+
+  Create themes!
+]
+```
 This code produces these PDF pages:
 ![title slide](assets/simple.png)
 
-That's all to get you started!
+As you can see, creating slides is as simple as using the `#slide` function.
+You can also use different
+[themes](https://andreaskroepelin.github.io/typst-slides/book/theme-gallery/index.html)
+(contributions welcome if you happen to
+[create your own](https://andreaskroepelin.github.io/typst-slides/book/themes.html#create-your-own-theme)!)
+
+For dynamic content, the template also provides [a convenient API for complex
+overlays](https://andreaskroepelin.github.io/typst-slides/book/dynamic.html)
+
 For more details, visit the
 [book](https://andreaskroepelin.github.io/typst-slides/book)!
 
-There are also different
-[themes](https://andreaskroepelin.github.io/typst-slides/book/theme-gallery/index.html)
-to choose from!
-If you like, you can even
-[create your own](https://andreaskroepelin.github.io/typst-slides/book/themes.html#create-your-own-theme).
-
 **⚠ This template is in active development.
 While I try to make sure that the `main`-branch always is in a usable state,
 there are no compatibility guarantees!**
diff --git a/assets/Makefile b/assets/Makefile
@@ -0,0 +1,4 @@
+simple:
+	pdftoppm ../examples/simple.pdf ./simple -png
+	montage ./simple-* -geometry +50+50 -background LightGray ./simple.png
+	rm ./simple-*
diff --git a/assets/first-slide.png b/assets/first-slide.png
diff --git a/assets/simple.png b/assets/simple.png
diff --git a/assets/title-slide.png b/assets/title-slide.png
diff --git a/examples/simple.typ b/examples/simple.typ
@@ -13,10 +13,25 @@
 
 #slide(title: "A boring static slide")[
   Some boring static text.
+
+  #lorem(20)
 ]
 
 #slide[
   A fancy dynamic slide without a title.
-  More text.
-  #only(2)[This appears later!]
+  #uncover("2-")[This appears later!]
+]
+
+#slide(theme-variant: "wake up")[
+  Focus!
+]
+
+#new-section("Conclusion")
+
+#slide(title: "Take home message")[
+  Read the book!
+
+  Try it out!
+
+  Create themes!
 ]