Skip to content

Commit

Permalink
Add minimal quick start guide
Browse files Browse the repository at this point in the history
  • Loading branch information
mvriel committed Jul 1, 2024
1 parent 6e603c3 commit 6afdb3b
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
52 changes: 52 additions & 0 deletions docs/docs/developers/quickstart.md
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down

0 comments on commit 6afdb3b

Please sign in to comment.