Improve documentation

This commit is contained in:
nsubiron 2017-11-07 19:02:45 +01:00
parent 0966b3fee6
commit 47a12489f7
5 changed files with 30 additions and 12 deletions

View File

@ -5,7 +5,7 @@ This guide has been tested only on Ubuntu 16.04.
Install the build tools and dependencies
$ sudo apt-get install build-essential cmake ninja-build python3-pip
$ sudo apt-get install build-essential cmake ninja-build python3-pip python-dev curl autoconf libtool
$ sudo pip3 install protobuf
To avoid compatibility issues between Unreal Engine and the CARLA dependencies,
@ -14,14 +14,12 @@ and C++ runtime library. We use clang 3.9 and LLVM's libc++.
Install clang 3.9
$ wget -O - http://apt.llvm.org/llvm-snapshot.gpg.key|sudo apt-key add -
$ sudo apt-get update
$ sudo apt-get install -y clang-3.9 clang++-3.9
$ sudo apt-get install clang-3.9
You may need to change your default clang version to compile Unreal
$ sudo ln -s /usr/bin/clang-3.9 /usr/bin/clang
$ sudo ln -s /usr/bin/clang++-3.9 /usr/bin/clang++
$ sudo update-alternatives --install /usr/bin/clang++ clang++ /usr/lib/llvm-3.9/bin/clang++ 100
$ sudo update-alternatives --install /usr/bin/clang clang /usr/lib/llvm-3.9/bin/clang 100
Build Unreal Engine
-------------------
@ -49,6 +47,8 @@ takes a while
$ ./Setup.sh
Once it's done it should print "Success" if everything went well.
Download Epic Games' Automotive Materials package and install it under
"Unreal/CarlaUE4/Content/AutomotiveMaterials".
[How to download automotive materials](how_to_add_automotive_materials.md).
@ -73,6 +73,20 @@ Once the project is opened, it is required to manually link Epic's Automotive
Material to our vehicles.
[How to link automotive materials](how_to_add_automotive_materials.md).
Later, if you need to compile some changes without doing a full rebuild, you can
use the Makefile generated in the Unreal project folder
$ cd Unreal/CarlaUE4
$ make CarlaUE4Editor
Launching the editor
--------------------
To open the editor once the project is already built
$ cd Unreal/CarlaUE4
$ ~/UnrealEngine_4.17/Engine/Binaries/Linux/UE4Editor "$PWD/CarlaUE4.uproject"
Test (Optional)
---------------

View File

@ -1,4 +0,0 @@
How to make a release
=====================
Coming soon...

View File

@ -7,7 +7,7 @@ CARLA Documentation
* [CARLA Settings](carla_settings.md)
* [Troubleshooting](troubleshooting.md)
#### Compiling
#### Building from source
* [How to build on Linux](how_to_build_on_linux.md)
* [How to build on Windows](how_to_build_on_windows.md)
@ -15,6 +15,5 @@ CARLA Documentation
#### Development
* [How to make a release](how_to_make_a_release.md)
* [How to add assets](how_to_add_assets.md)
* [CarlaServer documentation](carla_server.md)

View File

@ -107,6 +107,9 @@ Note that vehicle controls are only available when networking is disabled.
Enter : jump
F : use the force
F11 : toggle fullscreen
Alt+F4 : quit
Settings
--------

View File

@ -1,6 +1,12 @@
Troubleshooting
===============
#### Editor hangs after hitting Play
By default, when CARLA is started it waits for a client to be connected and
control the vehicle. This is the intended behavior. This can be changed in
"./Unreal/CarlaUE4/Config/CarlaSettings.ini" changing `UseNetworking=false`.
#### Very low FPS in editor when not in focus
UE4 Editor goes to a low performance mode when out of focus. It can be disabled