Doc/installation (atteneder#68)

* doc: Removed system requirements and prerequisites from installation instructions

System requirements falsely imply that glTFast only works on those platforms. While not extensively tested on all platforms, it should work everywhere.
Minimum version definition in prerequisites is redundant to package manifest and prone to be outdated in the future.
Removed unused trademark note

* doc: Included installation instructions in table of content and upgrade guide

Partially applied template ToC layout

* doc: Correct 2 space indent (markdownlint)

* doc: Fixed listing installation items

* doc: Removed redundant installation instructions from `README.md` and merged it into `installation.md`.

* doc: Added registered trademark char to first appearance of Unity.

* doc: Added missing changelog entry about minimum required Unity version.

* doc: Fixed changelog entry

CHANGELOG.md

@@ -14,7 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [6.0.0] - 2023-10-04
 
 ### Added
-- Custom Extension API (`GLTFast.Extensions` namespace)
+- Custom Add-On API (`GLTFast.Addons` namespace)
 - Support for alternative JSON parsing via Newtonsoft JSON
 - `Accessor.ElementByteSize`: Byte size of one element of that accessor
 - `Accessor.ByteSize`: Overall byte size
@@ -29,6 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - (Export) Clearcoat material export support for HDRP Lit shader
 
 ### Changed
+- Bumped minimum Unity version to 2020.3.48f1
 - Renamed `GltfAnimation` to `Animation` for consistent naming.
 - Bumped Burst dependency version to 1.8.4
 - Bumped Mathematics dependency version to 1.3.1
@@ -43,10 +44,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Runtime tests
 - (Export) Setting for deterministic export (limits concurrency to ensure consistent output)
 - (DOTS) Support for [Entities 1.0][Entities1.0]
+
 ### Changed
 - Optimized `Accessor.GetAccessorAttributeType`
 - Optimized `GltfEntityAsset.ClearScenes` via Burst
-- Bump minimum unity version from 2019.4.7f1 to 2019.4.40f1
+- Bump minimum Unity version from 2019.4.7f1 to 2019.4.40f1
 
 ### Fixed
 - Compiler errors and warnings on Unity 2023.2 (and newer) due to using obsolete types.

Documentation~/TableOfContents.md

@@ -1,14 +1,15 @@
-* [Overview](index.md)
+* [Unity glTFast](index.md)
+  * [Installation](installation.md)
+  * [Upgrade guides](UpgradeGuides.md)
 * [Features](features.md)
 * Runtime
-    * [Import](ImportRuntime.md)
-    * [Export](ExportRuntime.md)
+  * [Import](ImportRuntime.md)
+  * [Export](ExportRuntime.md)
 * Editor
-    * [Import](ImportEditor.md)
-    * [Export](ExportEditor.md)        
+  * [Import](ImportEditor.md)
+  * [Export](ExportEditor.md)
 * [Project Setup](ProjectSetup.md)
 * More Information
-    * [Upgrade Guides](UpgradeGuides.md)
-    * [Known Issues](KnownIssues.md)
-    * [Physical Light Units in glTF](LightUnits.md)
-    * [Implementation Details](ImplementationDetails.md)
+  * [Known Issues](KnownIssues.md)
+  * [Physical Light Units in glTF](LightUnits.md)
+  * [Implementation Details](ImplementationDetails.md)

Documentation~/UpgradeGuides.md

@@ -20,7 +20,7 @@ For now, both the Unity variant and the original version will receive updates.
 The C# namespaces are identical between the variants, so all you need to do is:
 
 - Removed original *glTFast* (with package identifier `com.atteneder.gltfast`).
-- Add *Unity glTFast* (`com.unity.cloud.gltfast`).
+- [Install *Unity glTFast*](installation.html) (`com.unity.cloud.gltfast`).
 - Update assembly definition references (if your project had any).
 - Update any dependencies in your packages manifest (if your package had any)
 

Documentation~/installation.md

@@ -1,42 +1,41 @@
 # Installation
 
-Before you install the package, make sure you meet the [system requirement](#system-requirement) and [prerequisites](#prerequisites).
-
 ## Install the *Unity glTFast* package using the Unity Package Manager
 
 To install the *Unity glTFast* package, follow these steps:
 
-In your Unity project, go to Windows > Package Manager.
-On the status bar, select the Add (+) button.
-From the Add menu, select Add + package by name. Name and Version fields appear.
-In the Name field, enter `com.unity.cloud.gltfast`.
-Select Add.
-The Editor installs the latest available version of the package and any dependent packages.
-
-## System Requirement
+- In your Unity project, go to Windows > Package Manager.
+- On the status bar, select the Add (+) button.
+- From the Add menu, select Add + package by name. Name and Version fields appear.
+- In the Name field, enter `com.unity.cloud.gltfast`.
+- Select Add.
+- The Editor installs the latest available version of the package and any dependent packages.
 
-*Unity glTFast* supports the following platforms:
+## Optional Packages
 
-- WebGL
-- iOS (arm64 and armv7a)
-- Android (arm64 and armv7a)
-- Windows (64 bit)
-- Universal Windows Platform (x64, x86, ARM, ARM64)
-- MacOS Universal (Apple Silicon and Intel)
-- Linux (64 bit)
-- Lumin / Magic Leap
+There are some related package that improve *Unity glTFast* by extending its feature set.
 
-## Prerequisites
+- [Draco™ 3D Data Compression Unity Package][DracoUnity] (provides support for [KHR_draco_mesh_compression][ExtDraco])
+- [KTX™ for Unity][KtxUnity] (provides support for [KHR_texture_basisu][ExtBasisU])
+- [*meshoptimizer decompression for Unity*][Meshopt] (provides support for [EXT_meshopt_compression][ExtMeshopt])
 
-To use the package, you require the following:
+## Trademarks
 
-- A Unity version of 2020.1 or later. In the Unity Hub, go to **Installs** > **Official releases** to find the latest Long Term Support version.
+*Unity®* is a registered trademark of [Unity Technologies][unity].
 
-## Trademarks
+*Khronos®* is a registered trademark and [glTF™][gltf] is a trademark of [The Khronos Group Inc][khronos].
 
-*Unity* is a registered trademark of [Unity Technologies][unity].
+*KTX™* and the KTX logo are trademarks of the [The Khronos Group Inc][khronos].
 
-*Khronos®* is a registered trademark and *glTF™* is a trademark of [The Khronos Group Inc][khronos].
+*Draco™* is a trademark of [*Google LLC*][GoogleLLC].
 
+[DracoUnity]: https://github.com/atteneder/DracoUnity
+[ExtBasisU]: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_texture_basisu
+[ExtDraco]: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_draco_mesh_compression
+[ExtMeshopt]: https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/Vendor/EXT_meshopt_compression
+[gltf]: https://www.khronos.org/gltf
+[GoogleLLC]: https://about.google/
 [khronos]: https://www.khronos.org
+[KtxUnity]: https://docs.unity3d.com/Packages/com.unity.cloud.ktx@latest/
+[Meshopt]: https://docs.unity3d.com/Packages/com.unity.meshopt.decompress@latest/
 [unity]: https://unity.com

README.md

@@ -40,9 +40,16 @@ Read more about the workflows in the [documentation][workflows].
 
 ## Installing
 
-> **NOTE:** Consider switching to [Unity glTFast][UnityGltfast], a fork of this package that is developed and supported by [Unity][unity]. Consult the [upgrade guide](./Documentation~/UpgradeGuides.md#unity-fork) for details.
+To install the *Unity glTFast* package, follow these steps:
 
-[Installation instruction for the original glTFast](./Documentation~/Original.md).
+In your Unity project, go to Windows > Package Manager.
+On the status bar, select the Add (+) button.
+From the Add menu, select Add + package by name. Name and Version fields appear.
+In the Name field, enter `com.unity.cloud.gltfast`.
+Select Add.
+The Editor installs the latest available version of the package and any dependent packages.
+
+> **NOTE:** This package originally had the identifier `com.atteneder.gltfast`. Consult the [upgrade guide](./Documentation~/UpgradeGuides.md#unity-fork) to learn how to switch to the Unity version (`com.unity.cloud.gltfast`) or [install the original package](./Documentation~/Original.md).
 
 ### Optional Packages
 
@@ -124,22 +131,11 @@ limitations under the License.
 
 *Khronos®* is a registered trademark and [glTF™][gltf] is a trademark of [The Khronos Group Inc][khronos].
 
-*KTX™* and the KTX logo are trademarks of the [The Khronos Group Inc][khronos].
-
-*Draco™* is a trademark of [*Google LLC*][GoogleLLC].
-
-[DracoUnity]: https://github.com/atteneder/DracoUnity
-[ExtBasisU]: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_texture_basisu
-[ExtDraco]: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_draco_mesh_compression
-[ExtMeshopt]: https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/Vendor/EXT_meshopt_compression
 [gltf-spec]: https://www.khronos.org/registry/glTF/specs/2.0/glTF-2.0.html
 [gltf]: https://www.khronos.org/gltf
 [gltfasset_component]: ./Documentation~/Images/gltfasset_component.png  "Inspector showing a GltfAsset component added to a GameObject"
-[GoogleLLC]: https://about.google/
 [import-gif]: ./Documentation~/Images/import.gif  "Video showing glTF files being copied into the Assets folder and imported"
 [khronos]: https://www.khronos.org
-[KtxUnity]: https://docs.unity3d.com/Packages/com.unity.cloud.ktx@latest
-[Meshopt]: https://docs.unity3d.com/Packages/com.unity.meshopt.decompress@0.1/manual/index.html
 [unity]: https://unity.com
 [UnityGltfast]: https://docs.unity3d.com/Packages/com.unity.cloud.gltfast@latest/
 [workflows]: ./Documentation~/index.md#workflows