diff --git a/Documentation~/readme.md b/Documentation~/readme.md new file mode 100644 index 00000000..0b75556e --- /dev/null +++ b/Documentation~/readme.md @@ -0,0 +1,275 @@ +# **Getting the Package** + +## Prerequisites + +* Git Client +* Unity 2019.3+ (2019.2 works too, but 2019.3+ is recommended) +* ~Unity Technologies GitHub Account~ + +## Getting HLOD System + +HLOD System is provided as an individual package. Currently it is available only on GitHub. In later stages of development, it will be available through Unity Package Manager. + +HLOD System GitHub Repo URL is [https://github.com/Unity-Technologies/HLODSystem](https://github.com/Unity-Technologies/HLODSystem) + +Follow through to get the package to your local PC and work with it. + +### CLI + +**Step 1.** Run one of the following commands to clone the repo: + +$ git clone [https://github.com/Unity-Technologies/HLODSystem.git](https://github.com/Unity-Technologies/HLODSystem.git) + +or + +$ git clone [git@github.com:Unity-Technologies/HLODSystem.git](mailto:git@github.com) + +
user@DESKTOP /Dev$ git clone https://github.com/Unity-Technologies/HLODSystem.git remote: Enumerating objects: 150, done. remote: Counting objects: 100% (150/150), done. remote: Compressing objects: 100% (110/110), done. remote: Total 4179 (delta 76), reused 80 (delta 39), pack-reused 4029 Receiving objects: 100% (4179/4179), 139.22 MiB | 16.71 MiB/s, done. Resolving deltas: 100% (2684/2684), done. |
user@DESKTOP /Dev$ cd HLODSystem user@DESKTOP /Dev/HLODSystem$ git submodule update --init --recursive ... user@DESKTOP /MobileOpenWorldSample |
| Streaming using the Addressable system. Using this mode requires user install a separate package with package ID "com.unity.hlod.addressable" which in turn has dependency on the Addressable system package. |