improve the repo's main readme file

This commit is contained in:
Mamadou Babaei
2024-08-07 18:51:24 +02:00
parent 1d69364fb3
commit d73a4a557e
+9 -7
View File
@@ -4,27 +4,29 @@
### Documentation ### Documentation
For the official documentation please visit the [The SenseGlove Unreal Engine Handbook](https://unreal.docs.senseglove.com/). For the official documentation please visit [the SenseGlove Unreal Engine Handbook](https://unreal.docs.senseglove.com/).
### Extra Resources ### Extra Resources
For examples, demo scenes, tutorials, and extra resources please checkout [the SenseGlove Unreal Engine Handbook on the Epic Marketplace](https://www.unrealengine.com/marketplace/en-US/product/the-senseglove-unreal-engine-plugin), or [the Extra Resources section](Handbook/src/appendix/extra-resources.md) of the [The SenseGlove Unreal Engine Handbook](Handbook/). For examples, demo scenes, tutorials, and extra resources please check out [the Extra Resources section](Handbook/src/appendix/extra-resources.md) of [the SenseGlove Unreal Engine Handbook](Handbook/).
### How to Download and Install ### How to Download and Install
Various instructions on [how to download and install the SenseGlove Unreal Engine Plugin](Handbook/src/getting-started/installation/README.md) is available. It could either be installed through [the Epic Games Launcher](Handbook/src/getting-started/installation/epic-games-launcher.md), or [through Microsoft Azure DevOps repositories](Handbook/src/getting-started/installation/microsoft-azure-devops-repositories.md). Various instructions on [how to download and install the SenseGlove Unreal Engine Plugin](Handbook/src/getting-started/installation/README.md) are available. It could either be installed through [the Epic Games Launcher](Handbook/src/getting-started/installation/epic-games-launcher.md), or [through Microsoft Azure DevOps repositories](Handbook/src/getting-started/installation/microsoft-azure-devops-repositories.md).
For more information, visit [the SenseGlove Unreal Engine Handbook on the Epic Marketplace](https://www.unrealengine.com/marketplace/en-US/product/the-senseglove-unreal-engine-plugin).
### Platform Support Matrix ### Platform Support Matrix
We maintain [a platform support matrix](Handbook/src/appendix/platform-support-matrix.md) which constantly changes as we move forward towards our development goals. We maintain [a platform support matrix](Handbook/src/appendix/platform-support-matrix.md) which constantly changes as we move toward our development goals.
### Planned Features Completion Status ### Planned Features Completion Status
We also maintain [a list of planned features and their completion status](Handbook/src/appendix/planned-features-completion-status.md) as a kind of roadmap for this plugin. We also maintain [a list of planned features and their completion status](Handbook/src/appendix/planned-features-completion-status.md) as a roadmap for this plugin.
### Changelog ### Changelog
[A detailed changelog for this project](Handbook/src/appendix/changelog.md) is maintained as well. Please consult the changelog before upgrading to any newer release. [A detailed changelog for this project](Handbook/src/appendix/changelog.md) is also maintained. Please consult the changelog before upgrading to any newer release.
### Directory Structure ### Directory Structure
@@ -38,4 +40,4 @@ The SenseGlove plug-in for Unreal Engine is licensed under the terms of the [MIT
### Third-Party Licenses ### Third-Party Licenses
Please note that while the SenseGlove Unreal Engine Plugin is made available under the MIT License, it utilizes a few third-party libraries with permissive free licenses as well, in order to power various components. For a list of these libraries and their own respective open-source licenses take a look at [the third-party licenses](Handbook/src/license/third-party.md), please. Please note that while the SenseGlove Unreal Engine Plugin is made available under the MIT License, it utilizes a few third-party libraries with permissive free licenses as well, in order to power various components. For a list of these libraries and their own respective open-source licenses take a look at [the third-party licenses](Handbook/src/license/third-party.md), please.