docs: add docs for examples

SergioRibera · Apr 7, 2023 · e1a5218 · e1a5218
1 parent 8508a71
commit e1a5218
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/examples/simple_mobile/README.md b/examples/simple_mobile/README.md
@@ -0,0 +1,21 @@
+# Bevy Virtual Joystick Mobile
+This show how works on android
+
+|  Screenshot  |  Video  |
+|--------------|---------|
+|              |         |
+
+# Features
+- Float Joystick
+- Expansive area to interact with joystick
+
+> **NOTE:** The color in area is only for make it visible
+
+# Settings of this example
+- VirtualJoystickAxis::Both
+- VirtualJoystickType::Floating
+
+# Run example
+```sh
+cargo apk run
+```
diff --git a/examples/simple_pc/README.md b/examples/simple_pc/README.md
@@ -0,0 +1,11 @@
+# Bevy Virtual Joystick Pc Example
+This show how works on pc for debug, test and development workflow
+
+# Settings of this example
+- VirtualJoystickAxis::Both
+- VirtualJoystickType::Floating
+
+# Run example
+```sh
+cargo run
+```