diff --git a/docs/assets/deck.svg b/docs/assets/deck.svg index 736c84b..c5da05f 100644 --- a/docs/assets/deck.svg +++ b/docs/assets/deck.svg @@ -334,45 +334,45 @@ - + ╭─────────── 1 | What is Spiel? ────────────╮╭────────── 2 | Decks and Slides ───────────╮╭─────────── 3 | Dynamic Content ───────────╮ ││││││ │What isWhy use││Decks are made of Slides││Slides can have dynamic│ │Spiel?Spiel?││││content!│ -│││Here's the code for Deck and│││ -│Spiel is aIt's fun!││Slide!││Since slides are created using│ -│││││normal Python code,any output│ -│ContributiInspiration││The source code is pulled││you can imagine producing via│ -│ngs││directly from the definitions││Python can make it into your│ -│││via inspect.getsource.││slides.│ -│PleaseBrandon││┌──────────────────┐┌───────────────────┐│││ +│││ Here's the code for Deck and  │││ +│Spiel is a It's fun! ││Slide!             ││Since slides are created using │ +│││││normal Python code, any output │ +│ContributiInspiration││   The source code is pulled   ││ you can imagine producing via │ +│ngs││ directly from the definitions ││ Python can make it into your  │ +│││    via inspect.getsource.     ││            slides.            │ +│  Please    Brandon  ││┌──────────────────┐┌───────────────────┐│││ ╰───────────────────────────────────────────╯╰───────────────────────────────────────────╯╰───────────────────────────────────────────╯ ╭────────────── 4 | Triggers ───────────────╮╭────────── 5 | Triggers: Reveals ──────────╮╭──────── 6 | Triggers: Animations ─────────╮ ││││││ │Triggers││Triggers: Reveals││Triggers: Animations│ ││││││ -│Triggers are a mechanism for││Triggers can be useful even││Here's an example of how│ -│making dynamic content that││without considering their││triggers can be used to build│ -│depends on relative time.││tracking of relative time.││more complex animations.│ +│ Triggers are a mechanism for  ││  Triggers can be useful even  ││   Here's an example of how    │ +│  making dynamic content that  ││   without considering their   ││ triggers can be used to build │ +│   depends on relative time.   ││  tracking of relative time.   ││   more complex animations.    │ ││││││ -│Triggers can be used to││We can track the number of││The position and facing│ -│implement effects like fades,││times the slide has been││direction of the bullet are│ -│motion, and other "animations".││triggered to graduallyreveal││calculated deterministically│ -│││content.││based on the time since the│ +│    Triggers can be used to    ││  We can track the number of   ││    The position and facing    │ +│ implement effects like fades, ││   times the slide has been    ││  direction of the bullet are  │ +│motion, and other "animations".││ triggered to gradually reveal ││ calculated deterministically  │ +│││           content.            ││  based on the time since the  │ ╰───────────────────────────────────────────╯╰───────────────────────────────────────────╯╰───────────────────────────────────────────╯ ╭──────────────── 7 | Views ────────────────╮╭────────── 8 | Displaying Images ──────────╮╭───────────── 9 | Watch Mode ──────────────╮ │││┏━━━━━━━━━━━━━━━━━━━┓│││ │Deck View││Images┃▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┃││Developing a Deck│ │││┃▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┃│││ -│Try pressing d to go into││Spiel can┃▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┃││Spiel will reload your deck as│ -│"deck" view.You can move││display┃▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┃││you edit it to make development│ -│between slides in deck view││images...┃▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┃││easier.│ -│using your arrow keys (right →,││sort of!┃▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┃│││ -│left ←, up ↑, and down ↓).││┃▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┃││The reload is triggered│ -│││Spiel┃▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┃││whenever any files under the│ -│Press enter or escape to go││includes┃▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┃││path passed to the--watch│ -│back to "slide" view (this││an Image┗━━━━ tree.jpg ━━━━━┛││argument of spiel present│ +│   Try pressing d to go into   ││Spiel can ┃▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┃││Spiel will reload your deck as │ +│   "deck" view. You can move   ││ display  ┃▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┃││you edit it to make development│ +│  between slides in deck view  ││images... ┃▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┃││            easier.            │ +│using your arrow keys (right →,││ sort of! ┃▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┃│││ +│  left ←, up ↑, and down ↓).   ││┃▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┃││    The reload is triggered    │ +│││  Spiel   ┃▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┃││ whenever any files under the  │ +│  Press enter or escape to go  ││ includes ┃▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┃││  path passed to the --watch│ +│  back to "slide" view (this   ││ an Image┗━━━━ tree.jpg ━━━━━┛││   argument of spiel present│ ╰───────────────────────────────────────────╯╰───────────────────────────────────────────╯╰───────────────────────────────────────────╯ ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Spiel Demo Deck | Triggers: Reveals                                                                  2022-12-17 03:31 PM   [05 / 11] diff --git a/docs/assets/demo.svg b/docs/assets/demo.svg index a82284e..d4e3aa5 100644 --- a/docs/assets/demo.svg +++ b/docs/assets/demo.svg @@ -157,34 +157,34 @@ - + What is Spiel?Why use Spiel? -Spiel is a framework for building and presentingIt's fun! -richly-styled presentations in your terminal using -Python.It's weird! +Spiel is a framework for building and presenting                           It's fun!                        +  richly-styled presentations in your terminal using    +                        Python.                                              It's weird!                       -Spiel uses Rich to render slide content.Anything youWhy not? + Spiel uses Rich to render slide content. Anything you                        Why not?                         can display with Rich, you can display with Spiel (plus -some other things)!Maybe you shouldn't. +                  some other things)!                                   Maybe you shouldn't.                   -Use your right → and left ← arrows keys to go forwardsHonestly, it's unclear whether it's a good idea. -and backwards through the deck.Press ctrl-c to exit. -There's always Powerpoint! -Press ? at any time to see the help screen, which -describes all of the built-in actions you can take. +Use your right → and left ← arrows keys to go forwards    Honestly, it's unclear whether it's a good idea.     + and backwards through the deck. Press ctrl-c to exit.  +              There's always Powerpoint!                +   Press ? at any time to see the help screen, which    +  describes all of the built-in actions you can take.   ContributingInspirations -Please report bugs via GitHub Issues.Brandon Rhodes' PyCon 2017 and North Bay Python 2017 -talks. -If you have ideas about how Spiel can be improved,or -you have a cool deck to show off,please post to GitHubDavid Beazley's Lambda Calculus from the Ground Up -Discussions.tutorial at PyCon 2019. +         Please report bugs via GitHub Issues.          Brandon Rhodes' PyCon 2017 and North Bay Python 2017 +                        talks.                          + If you have ideas about how Spiel can be improved, or  +you have a cool deck to show off, please post to GitHub  David Beazley's Lambda Calculus from the Ground Up +Discussions.                                      tutorial at PyCon 2019.                 -LaTeX's Beamer document class. +            LaTeX's Beamer document class.              diff --git a/docs/assets/quickstart_code.svg b/docs/assets/quickstart_code.svg index 4845d45..a5a0e35 100644 --- a/docs/assets/quickstart_code.svg +++ b/docs/assets/quickstart_code.svg @@ -44,7 +44,7 @@ .spieldocs-r10 { fill: #66d9ef } .spieldocs-r11 { fill: #f8f8f2 } .spieldocs-r12 { fill: #e6db74 } -.spieldocs-r13 { fill: #f92672 } +.spieldocs-r13 { fill: #ff4689 } .spieldocs-r14 { fill: #e1e1e1;font-weight: bold } @@ -194,16 +194,16 @@ - + Decks are made of Slides -Here's the code for Deck and Slide! +                                               Here's the code for Deck and Slide!                                                 -The source code is pulled directly from the definitions via inspect.getsource. +                          The source code is pulled directly from the definitions via inspect.getsource.                           -(Rich supports syntax highlighting, so Spiel does too!) +                                     (Rich supports syntax highlighting, so Spiel does too!)                                       ┌────────────────────────────────────────────────────────────────────┐┌────────────────────────────────────────────────────────────────────┐ │12 @dataclass││19 @dataclass│