Skip to content

Commit e0197d9

Browse files
Better describe version dependencies
1 parent 31a3360 commit e0197d9

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

docs/getting-started.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Getting started
22

33
When running this simulator there are two main components: the simulator and the ros bridge.
4-
Your autonomous system and the ros bridge should use the same ros core, either by running on the same computer or through a network connection.
4+
Your autonomous system and the ros bridge should use the same ros core, either by running on the same computer or through a network connection. It is required that the simulator and the ros bridge have the same version!
55

66
This page is an overview of the different methods to get these components up and running.
77

@@ -41,6 +41,12 @@ Try driving the car around using the arrowkeys.
4141
If you want to run the unreal engine project from source you will need [unreal engine and visual studio 2019](software-install-instructions.md).
4242
On Ubuntu you can skip the visual studio 2019 part.
4343

44+
#### Get the repository
45+
46+
You can either download the repo using the big green download button on the [github page of this project](https://github.com/FS-Online/Formula-Student-Driverless-Simulator) or clone the repository. For cloning, checkout the documentation on this further down this page.
47+
48+
When downloading or cloning, by default you get the latest, unreleased version. This is probably not the version that you want. Make sure you select the version that you need!
49+
4450
#### Compiling the AirSim plugin
4551
The Unreal Engine project requires the AirSim plugin.
4652
We have to compile this plugin first.
@@ -132,6 +138,8 @@ If you want to share the the clone directory with the Ubuntu WSL system, create
132138
ln -s /mnt/c/Users/developer/Formula-Student-Driverless-Simulator ~/Formula-Student-Driverless-Simulator
133139
```
134140

141+
Now, checkout the version equal to the simulator. If you are running for example simulator packaged version beta-3, run `git checkout beta-3` to get the ros brige to the same version
142+
135143
### Preparing AirLib
136144

137145
AirLib is the shared code between the ros wrapper and the AirSim Unreal Engine plugin.

0 commit comments

Comments
 (0)