diff --git a/docs/docs/developers/quickstart.md b/docs/docs/developers/quickstart.md new file mode 100644 index 0000000..51190d4 --- /dev/null +++ b/docs/docs/developers/quickstart.md @@ -0,0 +1,52 @@ +# Quick Start Guide + +!!! info + + This quickstart is aimed at developers who want to build on top of this platform, if all + you want is to deploy it pre-configured on your platform, please read the guide on + deploying using Docker. + +## Prerequisites + +Netherlands3D is developed in Unity, thus you'll need few prerequisites to start with the platform: + +1. Install Unity, the recommended version is Unity 2023 LTS, including the WebGL build options. Please check the Unity + Download Page -or Unity Hub- and the official Installation Guide for assistance. +2. Basic understanding of Unity and C# programming language. + +## Getting Started + +1. Firstly, clone the Netherlands3D/twin repository from GitHub: + + ```bash + git clone https://github.com/Netherlands3D/twin.git + ``` + +2. Once cloned, open the project in Unity. After the project has loaded, you can start tweaking and modifying the + application as per your needs. + +Do make sure that your build settings are set to build the project as a WebGL application, as several functionalities +are tailored to that platform. + +## Recommendations + +### Copy the Main scene + +It's recommended to create a copy of the 'Main' scene before making any modifications. This ensures that you're not +directly altering the original scene which, as the project is in continuous development, can lead to conflicts. + +To copy a scene in Unity: + +* Select the 'Main' scene in the Project window. +* Press Ctrl+D or right-click and select 'Duplicate' from the context menu. + +### Inspect the Configuration and ConfigurationStarter Scriptable Objects + +Check the 'Configuration' and 'ConfigurationStarter' scriptable objects for initial settings of the project. This +includes the starting position of your digital twin. These configurable parameters allow you to customize initial +settings as per your requirements. + +## Next Steps + +With just these steps, you can immediately build and release your own customized Digital Twin; next up you can read up +on what and how you can configure the platform without making any code changes. diff --git a/mkdocs.yml b/mkdocs.yml index f09f6b0..3c697b4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -65,6 +65,7 @@ nav: # - 'docs/TileSystemGebruiken.md' # - 'docs/DataKlaarzetten.md' # - 'docs/DataKoppelen.md' + - 'docs/developers/quickstart.md' - 'docs/developers/configuration.md' - 'Functionalities': - 'docs/developers/features/index.md'