Updated documentation and small fixies in BuildCarlaUE4

Docs/how_to_build_on_windows.md

@@ -51,15 +51,13 @@ Once you have downloaded the repo and extract the Carla contents you can start w
 
 | Command | Description |
 | --- | --- |
+| `make help` | Print all available commands |
 | `make launch`| Builds and launches Carla |
-| `make launch-only` | Launches Carla Editor |
-| `make package` | Builds CARLA and creates a packaged version for distribution. |
-| `make docs` | Generate the source code documentation |
+| `make launch-editor` | Launches Carla Editor |
+| `make package` | Builds CARLA and creates a packaged version for distribution |
 | `make clean` | Deletes all the binaries and temporals generated by the build system |
 | `make rebuild` | Rebuilds Carla project, dependencies not build |
-| `make CarlaUE4Editor` | Builds and launches Carla Editor |
-| `make LibCarla` | Builds the client and the server of the Carla API |
-| `make PythonAPI` | Generates the Python API for the client |
+
 
 If you build Carla for the first time or after you clean the project it will probably ask you to build the `UE4Editor-CarlaUE4.dll` and `UE4Editor-Carla.dll` also (as is needed for coocking the content for launch Carla), agree and the project will be opened in the Unreal Engine in a few minutes.
 

Util/BuildTools/BuildCarlaUE4.bat

@@ -45,7 +45,7 @@ if not "%1"=="" (
         shift
     )
 
-    if "%1"=="--launch" (
+    if "%1"=="--launch-editor" (
         set LAUNCH_UE4_EDITOR=true
     )
 
@@ -126,8 +126,6 @@ if %REMOVE_INTERMEDIATE% == true (
 rem Generate Visual Studio solution
 rem
 set genVsSolution=false
-if %BUILD_CARLAUE4% == true set genVsSolution=true
-if %BUILD_CARLAUE4_EDITOR%  == true set genVsSolution=true
 
 if not exist "%CARLA_FOLDER%CarlaUE4.sln" set genVsSolution=true
 if %REMOVE_INTERMEDIATE% == true set genVsSolution=false

Util/BuildTools/Windows.mk

@@ -12,29 +12,29 @@ help:
 	@type "${CARLA_BUILD_TOOLS_FOLDER}\Linux.mk.help"
 
 launch: LibCarla
-	@${CARLA_BUILD_TOOLS_FOLDER}/BuildCarlaUE4.bat --build --ue-version 4.19
+	@"${CARLA_BUILD_TOOLS_FOLDER}/BuildCarlaUE4.bat" --build --ue-version 4.19
 
-launch-only:
-	@${CARLA_BUILD_TOOLS_FOLDER}/BuildCarlaUE4.bat --launch --ue-version 4.19
+launch-editor: LibCarla
+	@"${CARLA_BUILD_TOOLS_FOLDER}/BuildCarlaUE4.bat" --launch-editor
 
 package: PythonAPI
-	@${CARLA_BUILD_TOOLS_FOLDER}/Package.bat --ue-version 4.19
+	@"${CARLA_BUILD_TOOLS_FOLDER}/Package.bat" --ue-version 4.19
 
 docs:
 	@doxygen
 	@echo "Documentation index at ./Doxygen/html/index.html"
 
 clean:
-	@${CARLA_BUILD_TOOLS_FOLDER}/Package.bat --clean --ue-version 4.19
-	@${CARLA_BUILD_TOOLS_FOLDER}/BuildCarlaUE4.bat --clean
+	@"${CARLA_BUILD_TOOLS_FOLDER}/Package.bat" --clean --ue-version 4.19
+	@"${CARLA_BUILD_TOOLS_FOLDER}/BuildCarlaUE4.bat" --clean
 
-	@${CARLA_BUILD_TOOLS_FOLDER}/BuildPythonAPI.bat --clean
-	@${CARLA_BUILD_TOOLS_FOLDER}/BuildLibCarla.bat --clean
+	@"${CARLA_BUILD_TOOLS_FOLDER}/BuildPythonAPI.bat" --clean
+	@"${CARLA_BUILD_TOOLS_FOLDER}/BuildLibCarla.bat" --clean
 
 rebuild: setup
-	@${CARLA_BUILD_TOOLS_FOLDER}/BuildLibCarla.bat --rebuild
-	@${CARLA_BUILD_TOOLS_FOLDER}/BuildPythonAPI.bat --rebuild
-	@${CARLA_BUILD_TOOLS_FOLDER}/BuildCarlaUE4.bat --rebuild --ue-version 4.19
+	@${CARLA_BUILD_TOOLS_FOLDER}/BuildLibCarla.bat" --rebuild
+	@${CARLA_BUILD_TOOLS_FOLDER}/BuildPythonAPI.bat" --rebuild
+	@${CARLA_BUILD_TOOLS_FOLDER}/BuildCarlaUE4.bat" --rebuild --ue-version 4.19
 
 check: PythonAPI
 	@echo "Not implemented!"
@@ -43,18 +43,15 @@ benchmark: LibCarla
 	@echo "Not implemented!"
 
 CarlaUE4Editor: LibCarla
-	@${CARLA_BUILD_TOOLS_FOLDER}/BuildCarlaUE4.bat --build-editor --ue-version 4.19
+	@"${CARLA_BUILD_TOOLS_FOLDER}/BuildCarlaUE4.bat" --build-editor --ue-version 4.19
 
 .PHONY: PythonAPI
 PythonAPI: LibCarla
-	@${CARLA_BUILD_TOOLS_FOLDER}/BuildPythonAPI.bat --py3
+	@"${CARLA_BUILD_TOOLS_FOLDER}/BuildPythonAPI.bat" --py3
 
 .PHONY: LibCarla
 LibCarla: setup
-	@${CARLA_BUILD_TOOLS_FOLDER}\BuildLibCarla.bat --server --client
+	@"${CARLA_BUILD_TOOLS_FOLDER}/BuildLibCarla.bat" --server --client
 
 setup:
-	@${CARLA_BUILD_TOOLS_FOLDER}\Setup.bat --boost-toolset msvc-14.1
-
-pretty:
-	@echo "Not implemented!"
+	@"${CARLA_BUILD_TOOLS_FOLDER}/Setup.bat" --boost-toolset msvc-14.1

Util/BuildTools/Windows.mk.help

@@ -0,0 +1,69 @@
+Welcome to CARLA Simulator!
+===========================
+
+This Makefile will help you building the different CARLA utilities.
+
+Use the following commands:
+
+    help:
+
+        Display this help message.
+
+    launch:
+
+        Compile CarlaUE4 project and launch it in Unreal Engine's Editor.
+
+    launch-editor:
+
+        Launch CarlaUE4 project in Unreal Engine's Editor
+
+    package:
+
+        Makes a packaged version of CARLA ready for distribution.
+
+    docs:
+
+        Build CARLA Doxygen documentation.
+
+    clean:
+
+        Remove intermediate build files.
+
+    rebuild:
+
+        Remove intermediate build files and rebuild the whole project.
+
+    hard-clean:
+
+        Remove intermediate build files and dependencies, and force a
+        recompilation of Unreal Engine's pre-compiled headers. Useful for
+        fixing "version.h has been modified since the precompiled header"
+        errors. Beware, recompilation takes a long time!
+
+
+There are also some lower level commands for building individual modules helpful
+for developers:
+
+    check:
+
+        Run unit test suites for LibCarla and PythonAPI.
+
+    benchmark:
+
+        Run the benchmark tests for LibCarla.
+
+    CarlaUE4Editor:
+
+        Build CarlaUE4 project, but do not launch the editor.
+
+    PythonAPI:
+
+        Build and package the Python API module for Python 2 and 3.
+
+    LibCarla:
+
+        Build the LibCarla library, both "Server" and "Client" configurations.
+
+    setup:
+
+        Run the setup step only.