add the content for the overview page

2024-08-16 16:44:31 +02:00
parent 006165605f
commit 5bc78b7dc6
2 changed files with 75 additions and 10 deletions
@@ -59,14 +59,6 @@ Welcom to the SenseGlove Unreal Engine Handbook!
 - [Low-Level Blueprints API](low-level-api/blueprints.md)
 - [Low-Level C++ API](low-level-api/cpp.md)

-# 📜 License
-
- [SenseGlove Unreal Engine Plugin License](license/senseglove-unreal-engine-plugin.md)
- [Third-Party Licenses](license/third-party.md)
-    - [SenseGlove SDK License](license/senseglove-sdk.md)
-    - [Boost C++ Libraries](license/boost-cpp-libraries.md)
-    - [Serial Communication Library License](license/serial-communication-library.md)
-
 # 📑 Appendix

 - [Platform Support Matrix](appendix/platform-support-matrix.md)
@@ -75,6 +67,14 @@ Welcom to the SenseGlove Unreal Engine Handbook!
 - [Directory Structure](appendix/directory-structure.md)
 - [Extra Resources](appendix/extra-resources.md)

+# 📜 License
+
+- [SenseGlove Unreal Engine Plugin License](license/senseglove-unreal-engine-plugin.md)
+- [Third-Party Licenses](license/third-party.md)
+    - [SenseGlove SDK License](license/senseglove-sdk.md)
+    - [Boost C++ Libraries](license/boost-cpp-libraries.md)
+    - [Serial Communication Library License](license/serial-communication-library.md)
+
 -----------

 - [ℹ️](misc/build-information.md)
@@ -1,7 +1,72 @@
 # Overview

-In order to make it easy to follow the content of this handbook the documentation has been divded into various sections:
+To help you navigate the SenseGlove Unreal Engine Handbook, we have organized the content into several key sections. This structured layout aims to simplify your journey through the SenseGlove Unreal Engine Plugin, providing clear and detailed guidance at every step.

- The __📑 Appendix__ section contains various useful information such as [the Platform Support Matrix](appendix/platform-support-matrix.md), [the Planned Features Completion Status](appendix/planned-features-completion-status.md), [the Changelog](appendix/changelog.md), and [the Plugin's Directory Structure](appendix/directory-structure.md).
+## 🚀 Getting Started

+This section covers the basics of the SenseGlove Unreal Engine Plugin:

+- [Installation](getting-started/installation/README.md)
+    - [Through the Epic Games Launcher](getting-started/installation/epic-games-launcher.md)
+    - [Through Microsoft Azure DevOps Repositories](getting-started/installation/microsoft-azure-devops-repositories.md)
+- [Enabling and Verifying the Plugin Version](getting-started/plugin-verify-version-enable/README.md)
+- [SenseCom](getting-started/sensecom/README.md)
+    - [SenseCom on GNU/Linux](getting-started/sensecom/gnu-linux/README.md)
+        - [Connect to Nova gloves using Blueman Bluetooth Manager](getting-started/sensecom/gnu-linux/blueman-bluetooth-manager.md)
+        - [Connect to Nova gloves using Command-line](getting-started/sensecom/gnu-linux/command-line.md)
+    - [SenseCom on Microsoft Windows](getting-started/sensecom/microsoft-windows.md)
+- [Enabling XR_EXT_hand_tracking on VR Headsets](getting-started/enabling-xr-ext-hand-tracking-vr-headsets/README.md)
+- [Setup the SGPawn]()
+- [Setup a Virtual Hand Model]()
+- [Setup the Grab System]()
+- [Setup the Touch System]()
+
+## ⚙️ Plugin Configuration
+
+This section provides detailed information on configuring the plugin:
+
+- [Plugin Settings](plugin-configuration/plugin-settings/README.md)
+    - [Initialization](plugin-configuration/plugin-settings/initialization/README.md)
+    - [Game User Settings](plugin-configuration/plugin-settings/game-user-settings/README.md)
+        - [Hardware-benchmarking](plugin-configuration/plugin-settings/game-user-settings/hardware-benchmarking.md)
+    - [Tracking](plugin-configuration/plugin-settings/tracking/README.md)
+        - [Glove-tracking](plugin-configuration/plugin-settings/tracking/glove-tracking.md)
+        - [Hand-tracking](plugin-configuration/plugin-settings/tracking/hand-tracking.md)
+        - [HMD-tracking](plugin-configuration/plugin-settings/tracking/hmd-tracking.md)
+        - [Wrist-tracking](plugin-configuration/plugin-settings/tracking/wrist-tracking/README.md)
+            - [Debugging](plugin-configuration/plugin-settings/tracking/wrist-tracking/debugging.md)
+    - [Virtual Hand](plugin-configuration/plugin-settings/virtual-hand/README.md)
+        - [Animation](plugin-configuration/plugin-settings/virtual-hand/animation.md)
+        - [Debugging](plugin-configuration/plugin-settings/virtual-hand/debugging.md)
+        - [Grab](plugin-configuration/plugin-settings/virtual-hand/grab.md)
+        - [Haptics](plugin-configuration/plugin-settings/virtual-hand/haptics.md)
+        - [Mesh](plugin-configuration/plugin-settings/virtual-hand/mesh.md)
+        - [Touch](plugin-configuration/plugin-settings/virtual-hand/touch.md)
+- [Overriding Settings](plugin-configuration/overriding-settings/README.md)
+
+## 🛠️ Advanced Topics
+
+For users familiar with the basics, this section explores advanced features of the plugin:
+
+- [Safe Glove Access in Blueprint](advanced-topics/safe-glove-access-blueprint/README.md)
+- [OpenXR](advanced-topics/openxr/README.md)
+    - [Consuming FXRMotionControllerData](advanced-topics/openxr/consuming-fxrmotioncontrollerdata/README.md)
+        - [Blueprints](advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprint.md)
+        - [C++](advanced-topics/openxr/consuming-fxrmotioncontrollerdata/cpp.md)
+
+## 🔌 Low-Level API
+
+This section delves into the SenseGlove low-level API:
+
+- [Low-Level Blueprints API](low-level-api/blueprints.md)
+- [Low-Level C++ API](low-level-api/cpp.md)
+
+## 📑 Appendix
+
+The appendix contains various extra useful information:
+
+- [Platform Support Matrix](appendix/platform-support-matrix.md)
+- [Planned Features Completion Status](appendix/planned-features-completion-status.md)
+- [Changelog](appendix/changelog.md)
+- [Directory Structure](appendix/directory-structure.md)
+- [Extra Resources](appendix/extra-resources.md)