Add a user facing readme

sourcebots · Jul 29, 2024 · 0d7d190 · 0d7d190
1 parent 479e5d6
commit 0d7d190
Show file tree

Hide file tree

Showing 21 changed files with 295 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -136,9 +136,9 @@ Of the the folders that are not included in the release, the `tests` folder cont
 12. ~~setup script~~
 13. ~~releases~~
 14. documentation
-    1. dev setup
+    1. ~~dev setup~~
     2. user usage
-    3. how it works
+    3. ~~how it works~~
 15. simulator tests
     - vision position
     - vision orientation

diff --git a/assets/images/camera-overlays.png b/assets/images/camera-overlays.png
diff --git a/assets/images/leds.png b/assets/images/leds.png
diff --git a/assets/images/open-with-python.png b/assets/images/open-with-python.png
diff --git a/assets/images/optional-rendering.png b/assets/images/optional-rendering.png
diff --git a/assets/images/python_download.png → assets/images/python-download.png b/assets/images/python_download.png → assets/images/python-download.png
diff --git a/assets/images/python-unfound.png b/assets/images/python-unfound.png
diff --git a/assets/images/reduced-settings.png b/assets/images/reduced-settings.png
diff --git a/assets/images/reduced_settings.png b/assets/images/reduced_settings.png
diff --git a/assets/images/release-contents.png b/assets/images/release-contents.png
diff --git a/assets/images/restore-camera-overlay.png b/assets/images/restore-camera-overlay.png
diff --git a/assets/images/robot-bottom.png b/assets/images/robot-bottom.png
diff --git a/assets/images/robot.png b/assets/images/robot.png
diff --git a/assets/images/time-controls.png b/assets/images/time-controls.png
diff --git a/assets/images/ui-overview-unannotated.png b/assets/images/ui-overview-unannotated.png
diff --git a/assets/images/ui-overview.png b/assets/images/ui-overview.png
diff --git a/assets/images/ultrasound.png b/assets/images/ultrasound.png
diff --git a/assets/images/webots_download.png → assets/images/webots-download.png b/assets/images/webots_download.png → assets/images/webots-download.png
diff --git a/assets/images/windows_preferences.png → assets/images/windows-preferences.png b/assets/images/windows_preferences.png → assets/images/windows-preferences.png
diff --git a/assets/user_readme.md b/assets/user_readme.md
diff --git a/scripts/generate_release.py b/scripts/generate_release.py
@@ -58,6 +58,9 @@
         subprocess.run(
             [
                 "pandoc",
+                "--toc",  # Add a table of contents
+                "--from", "gfm+definition_lists",  # Use GitHub Flavored Markdown
+                "--shift-heading-level-by=-1",  # Make the level 1 heading the title
                 "--self-contained",  # Embed images in the HTML
                 "--metadata",
                 'pagetitle="title"',