Skip to content

Commit

Permalink
Improve example GIF (#129)
Browse files Browse the repository at this point in the history
  • Loading branch information
ofek authored May 13, 2024
1 parent a9b2e2b commit 0ec7261
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 2 deletions.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,25 @@

PyApp is a wrapper for Python applications that bootstrap themselves at runtime.

<img src="https://raw.githubusercontent.com/ofek/pyapp/master/docs/assets/images/example.gif" alt="PyApp example workflow" role="img">
<div align="center">
<table>
<tr><th>You build</th></tr>
<tr>
<td>
<img src="https://raw.githubusercontent.com/ofek/pyapp/master/docs/assets/images/example-build.gif" alt="PyApp example build" role="img">
</td>
</tr>
</table>

<table>
<tr><th>User runs</th></tr>
<tr>
<td>
<img src="https://raw.githubusercontent.com/ofek/pyapp/master/docs/assets/images/example-run.gif" alt="PyApp example run" role="img">
</td>
</tr>
</table>
</div>

See the [how-to](https://ofek.dev/pyapp/latest/how-to/) for a detailed example walkthrough.

Expand Down
Binary file added docs/assets/images/example-build.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/example-run.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/images/example.gif
Binary file not shown.
12 changes: 11 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,17 @@

PyApp is a wrapper for Python applications that bootstrap themselves at runtime.

![PyApp example workflow](assets/images/example.gif){ loading=lazy role="img" }
<div align="center" markdown>

| You build |
| :---: |
| ![PyApp example build](assets/images/example-build.gif){ loading=lazy role="img" } |

| User runs |
| :---: |
| ![PyApp example run](assets/images/example-run.gif){ loading=lazy role="img" } |

</div>

See the [how-to](how-to.md) for a detailed example walkthrough.

Expand Down
1 change: 1 addition & 0 deletions hatch.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[envs.docs]
detached = true
installer = "uv"
dependencies = [
"mkdocs~=1.5.3",
"mkdocs-material~=9.5.18",
Expand Down

0 comments on commit 0ec7261

Please sign in to comment.