diff --git a/README.md b/README.md index 2d5f17d..e73feda 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,23 @@ -Welcome to Sumo2Unity Integration +Welcome to Sumo2Unity Tool ## Introduction Sumo2Unity seamlessly integrates SUMO (Simulation of Urban MObility) with Unity, a powerful 3D game engine. This open-source project bridges the gap between microscopic traffic simulation and real-time 3D visualization, empowering you to Immerse yourself in a simulated traffic network. This will help to gain deeper insights through real-time observation and interaction. This can be used to leverage the combined power of both platforms for research, development, and educational applications in transportation. +**Check out the quick 1 minute demo** + +SUMO2Unity Tool - Fixed View + +[![YouTube Video](https://img.youtube.com/vi/AWS-hvQ5cqs/0.jpg)](https://youtu.be/J0fMM2HRTP4) + +SUMO2Unity Tool - Driver View + +[![YouTube Video](https://img.youtube.com/vi/AWS-hvQ5cqs/0.jpg)](https://youtu.be/AWS-hvQ5cqs) + ## Pre-Requisites -- Download latest version of [Sumo](https://eclipse.dev/sumo/). +- Download latest version of [Sumo](https://eclipse.dev/sumo/). We recommend version XYZ. - Download [Unity Hub](https://unity.com/download). - Once you install Unity Hub, download and install Unity Editor. We recommend version 2022.3.16f1. +- We recommend to use Windows/Mac. We have not tried it on Linux. ## Getting Started - Clone this repo to your computer `git clone https://github.com/SUMO2Unity/SUMO2Unity` or download this repo as a zip file. @@ -20,7 +31,7 @@ Sumo2Unity seamlessly integrates SUMO (Simulation of Urban MObility) with Unity, - To change simulation, click on `Edit > Open network in netedit` or press `ctrl + T`. - You can add or modify vehicles, traffic signals, or pedestrians in the Simulation. -## Additional Help +## Tutorials - How to clone a repository? [Youtube Tutorial](https://www.youtube.com/watch?v=EhxPBMQFCaI) - How to download Unity? [Youtube Tutorial](https://www.youtube.com/watch?v=Kh_FD0Ypdhg) - How to install Sumo? [Youtube Tutorial](https://www.youtube.com/watch?v=7DfVUwgUIlQ) @@ -28,7 +39,7 @@ Sumo2Unity seamlessly integrates SUMO (Simulation of Urban MObility) with Unity, ## Documentation - Please Visit our Documentation [here](https://sumo2unitydocumentation.readthedocs.io/en/latest/) for additional details - + ## License - Add Licensing details