Added Examples Page (#203)

* Added examples page link * Added bezier path gif * Drafted first table for examples * Rendered examples properly * Added explanation for example * Fixed reference
JuliaAnimators · Sep 25, 2020 · 2386128 · 2386128
1 parent 2f13ce0
commit 2386128
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -23,6 +23,7 @@ makedocs(;
             "tutorials/tutorial_6.md",
         ],
         "HowTo" => "howto.md",
+        "Examples" => "examples.md",
         "Mission" => "mission.md",
         "References" => "references.md",
         "Contributing" => "contributing.md",

diff --git a/docs/src/assets/follow_bezier_path.gif b/docs/src/assets/follow_bezier_path.gif
diff --git a/docs/src/examples.md b/docs/src/examples.md
@@ -0,0 +1,9 @@
+## Examples
+
+Aside from tutorials which take you step by step on how to create a tutorial, we also felt that it useful to show additional examples on things you can make with `Javis`!
+These animations do not have an accompanying tutorial but rather, scripts that you can examine, tweak, and modify to suit your own purposes.
+If you have an interesting example that you would like to share with us, open an issue (check out our [Contributing Guide](contributing.md) on how to do this) and we'd be happy to add your example to this page!
+
+| Example                            | Link                                                                                               | Details                                                                                                                                                                                                                    |
+|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ![](assets/follow_bezier_path.gif) | [Follow a Path](https://github.com/Wikunia/Javis.jl/blob/master/examples/follow_path.jl) | This creates a bezier curve to draw the outline of a car and have a circle go around that outlined path. [`follow_path`](@ref), `makebezierpath`, and [`appear`](@ref) were used to create this animation. |