From 8fd425d3ce3f25d8de657a39121d3b4f1fe8d529 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Malta=20e=20Sousa?= Date: Thu, 12 Sep 2019 17:04:34 +0200 Subject: [PATCH] Update README.md --- README.md | 33 +++++++++++++++++++++++++++------ 1 file changed, 27 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3bcdf8a..6565b30 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,31 @@ -# sitn-vr +# SITNVR -sitn-vr is a prototype of importing different kind of GIS data into a VR environment. +SITNVR is a prototype of importing different kind of GIS data into a VR environment. ## File structure . - ├── datasource # Raw data - ├── documentation # Instructions to process data - ├── import # Scripts and their output to import data into unity - ├── unity # Unity project + ├── datasource # Raw sample data + ├── import # Scripts and their output to be imported into unity + ├── unity # Unity project + │ ├── Assets # Unity standard asset folder + │ │ ├── Audio + │ │ ├── Editor # Scripts meant to be used by Editor, will not be compiled + │ │ ├── Down Town Pack # From Asset Store + │ │ ├── Free_SpeedTrees # From Asset Store + │ │ ├── Materials + │ │ ├── Models # Generated 3D objects from FME + │ │ ├── Prefabs # Custom prefabs + │ │ ├── Scenes # Scenes showing state of project at each release + │ │ ├── Scripts # Scripts used in game + │ │ ├── SteamVR # SteamVR from Asset Store + │ │ ├── SteamVR_Input # SteamVR from Asset Store + │ │ ├── Street lights 1 # From Asset Store + │ │ ├── Terrain # Terrain and terrain layers + │ │ ├── TextMesh Pro # From Asset Store, better text + │ │ └── Textures + │ ├── Packages + │ └── ProjectSettings ├── LICENSE └── README.md @@ -30,3 +47,7 @@ Process the data: 1. Open the Unity Hub, click add and browse the `unity` folder at the root of this project 1. In the Assets explorer, open the `Scenes` folder and double click on `Proto01` 1. Hit the play button in Unity and enjoy + +## Documentation + +[Integration documentation](../../wiki)