removed minor versions from docs

Kokika · Jul 17, 2024 · ddaf545 · ddaf545
1 parent 385b82d
commit ddaf545
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,14 +1,14 @@
 ### June/July 2024 (Version 3.0)
-* Updated to be compatible with Unreal 5.4.2. 
-    * Note that 5.4.2 requires _r.DetailMode 2_ console command or scalability settings to be set to Epic to avoid issues with rendering the RGB scene camera sensor. More info [here](docs/unreal_custenv.md#unreal-5354-scene-camera-bug).
+* Updated to be compatible with Unreal 5.4. 
+    * Note that 5.4 requires _r.DetailMode 2_ console command or scalability settings to be set to Epic to avoid issues with rendering the RGB scene camera sensor. More info [here](docs/unreal_custenv.md#unreal-5354-scene-camera-bug).
     * Updated rpclib version to unofficial patched version 2.3.1 to better support C++20.
     * Updated Eigen version to unofficial patched version 3.4.1 to better support C++20.
     * Updated cpp-linenoise library of DroneShell to support C++20.
     * Updated json library to 3.11.3 to support C++20.
     * Updated airlib to use C++20.
-* Updated to be compatible with Unreal 5.3.2. 
-    * Note that 5.3.2 breaks debug rendering! Disable it to avoid issues in editor. [Fixed in 5.4](https://issues.unrealengine.com/issue/UE-199454)
-    * Note that 5.3.2 requires _r.DetailMode 2_ console command or scalability settings to be set to Epic to avoid issues with rendering the RGB scene camera sensor. More info [here](docs/unreal_custenv.md#unreal-5354-scene-camera-bug).
+* Updated to be compatible with Unreal 5.3. 
+    * Note that 5.3 breaks debug rendering! Disable it to avoid issues in editor. [Fixed in 5.4](https://issues.unrealengine.com/issue/UE-199454)
+    * Note that 5.3 requires _r.DetailMode 2_ console command or scalability settings to be set to Epic to avoid issues with rendering the RGB scene camera sensor. More info [here](docs/unreal_custenv.md#unreal-5354-scene-camera-bug).
 * Updated [ROS2 wrapper](docs/ros_cplusplus.md) to support Cosys-AirSim features and fix several issues:
     * Added support for annotation cameras.
     * Added support for GPU-Lidar and Echos sensors.

diff --git a/README.md b/README.md
@@ -58,7 +58,7 @@ You can also find the presentation of the live tutorial of Cosys-AirSim at ANNSI
 ```
 
 ## Cosys-Lab Modifications
-* Added support for Unreal up to 5.4.2 ([Note that Unreal 5.3/5.4 breaks camera scene rendering by default in custom environments](https://cosys-lab.github.io/unreal_custenv#unreal-5354-scene-camera-bug))
+* Added support for Unreal up to 5.4 ([Note that Unreal 5.3/5.4 breaks camera scene rendering by default in custom environments](https://cosys-lab.github.io/unreal_custenv#unreal-5354-scene-camera-bug))
 * Added [multi-layer annotation](https://cosys-lab.github.io/annotation) for groundtruth label generation with RGB, greyscale and texture options. Extensive API integration and available for camera and GPU-LiDAR sensors.
 * Added [Instance Segmentation](https://cosys-lab.github.io/instance_segmentation). 
 * Added [Echo sensor type](https://cosys-lab.github.io/echo) for simulation of sensors like sonar and radar.

diff --git a/build.cmd b/build.cmd
@@ -15,7 +15,7 @@ if "%VisualStudioVersion%" == "" (
 )
 if "%VisualStudioVersion%" lss "17.0" (
     echo(
-    echo Hello there! We just upgraded AirSim to Unreal Engine 5.4.2 and Visual Studio 2022.
+    echo Hello there! We just upgraded AirSim to Unreal Engine 5.4 and Visual Studio 2022.
     echo Here are few easy steps for upgrade so everything is new and shiny:
     echo https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/docs/unreal_upgrade.md
     goto :buildfailed_nomsg

diff --git a/docs/README.md b/docs/README.md
@@ -58,7 +58,7 @@ You can also find the presentation of the live tutorial of Cosys-AirSim at ANNSI
 ```
 
 ## Cosys-Lab Modifications
-* Added support for Unreal up to 5.4.2 ([Note that Unreal 5.3/5.4 breaks camera scene rendering by default in custom environments](https://cosys-lab.github.io/unreal_custenv#unreal-5354-scene-camera-bug))
+* Added support for Unreal up to 5.4 ([Note that Unreal 5.3/5.4 breaks camera scene rendering by default in custom environments](https://cosys-lab.github.io/unreal_custenv#unreal-5354-scene-camera-bug))
 * Added [multi-layer annotation](https://cosys-lab.github.io/annotation) for groundtruth label generation with RGB, greyscale and texture options. Extensive API integration and available for camera and GPU-LiDAR sensors.
 * Added [Instance Segmentation](https://cosys-lab.github.io/instance_segmentation). 
 * Added [Echo sensor type](https://cosys-lab.github.io/echo) for simulation of sensors like sonar and radar.

diff --git a/docs/install_linux.md b/docs/install_linux.md
@@ -4,10 +4,10 @@ The current recommended and tested environment is **Ubuntu 22.04 LTS**. Theoreti
 
 
 ## Install Unreal Engine
-Download Unreal Engine 5.4.2 from the [official download page]](https://www.unrealengine.com/en-US/linux). 
+Download the latest version of Unreal Engine 5.4 from the [official download page]](https://www.unrealengine.com/en-US/linux). 
 This will require an Epic Games account. Once the zip archive is downloaded you can extract it to where you want to install the Unreal Engine.
 ```bash
-unzip Linux_Unreal_Engine_5.4.2.zip -d destination_folder
+unzip Linux_Unreal_Engine_5.4.X.zip -d destination_folder
 ```
 If you chose a folder such as for example `/opt/UnrealEngine` make sure to provide permissions and to set the owner, otherwise you might run into issues:
 ```bash

diff --git a/docs/install_windows.md b/docs/install_windows.md
@@ -3,7 +3,7 @@
 ## Install Unreal Engine
 1. [Download](https://www.unrealengine.com/download) the Epic Games Launcher. While the Unreal Engine is open source and free to download, registration is still required.
 2. Run the Epic Games Launcher, open the `Unreal Engine` tab on the left pane.
-Click on the `Install` button on the top right, which should show the option to download **Unreal Engine 5.4.2**. Chose the install location to suit your needs, as shown in the images below. If you have multiple versions of Unreal installed then **make sure the version you are using is set to `current`** by clicking down arrow next to the Launch button for the version.
+Click on the `Install` button on the top right, which should show the option to download **Unreal Engine 5.4.X**. Chose the install location to suit your needs, as shown in the images below. If you have multiple versions of Unreal installed then **make sure the version you are using is set to `current`** by clicking down arrow next to the Launch button for the version.
 ![Unreal Engine Tab UI Screenshot](images/ue_install.png)
 ![Unreal Engine Install Location UI Screenshot](images/ue_install_location.png)
 

diff --git a/docs/ros_python.md b/docs/ros_python.md
@@ -4,7 +4,7 @@ AirSim and ROS can be integrated using Python. Some example ROS node are provide
 
 ## Prerequisites
 
-These instructions are for Ubuntu 20.04, ROS Noetic, UE 5.4.2 and latest AirSim release.
+These instructions are for Ubuntu 20.04, ROS Noetic, UE 5.4 and latest AirSim release.
 You should have these components installed and working before proceeding.
 
 **Note that you need to install the Python module first for this to work. More information [here](apis.md) in the section 'Installing AirSim Package'.**

diff --git a/docs/unreal_custenv.md b/docs/unreal_custenv.md
@@ -18,7 +18,7 @@ There is no `Epic Games Launcher` for Linux which means that if you need to crea
 
     !!!note
 
-        The Landscape Mountains project is supported up to Unreal Engine version 4.24. If you do not have 4.24 installed, you should see a dialog titled `Select Unreal Engine Version` with a dropdown to select from installed versions. Select 5.4.2 to migrate the project to a supported engine version. If you have 4.24 installed, you can manually migrate the project by navigating to the corresponding .uproject file in Windows Explorer, right-clicking it, and selecting the `Switch Unreal Engine version...` option. 
+        The Landscape Mountains project is supported up to Unreal Engine version 4.24. If you do not have 4.24 installed, you should see a dialog titled `Select Unreal Engine Version` with a dropdown to select from installed versions. Select 5.4 to migrate the project to a supported engine version. If you have 4.24 installed, you can manually migrate the project by navigating to the corresponding .uproject file in Windows Explorer, right-clicking it, and selecting the `Switch Unreal Engine version...` option. 
 
 4. Go to the `LandscapeMountains` project folder and create a new subfolder called `Plugins`. Now copy the precompiled AirSim Plugin folder into this newly created folder. This way now your own Unreal project has AirSim plugin.
 
@@ -67,7 +67,7 @@ There is no `Epic Games Launcher` for Linux which means that if you need to crea
 
 ## Step-by-Step Instructions when using Cosys-AirSim from Source Build
 
-1. Make sure AirSim is built and Unreal 5.4.2 is installed as described in [the installation instructions](install_windows.md).
+1. Make sure AirSim is built and Unreal 5.4 is installed as described in [the installation instructions](install_windows.md).
 2. In `Epic Games Launcher` click the Samples tab then scroll down and find `Landscape Mountains`. Click the `Create Project` and download this content (~2GB download). 
 
     ![current version](images/landscape_mountains.png)
@@ -78,7 +78,7 @@ There is no `Epic Games Launcher` for Linux which means that if you need to crea
 
     !!!note
 
-        The Landscape Mountains project is supported up to Unreal Engine version 4.24. If you do not have 4.24 installed, you should see a dialog titled `Select Unreal Engine Version` with a dropdown to select from installed versions. Select 5.4.2 to migrate the project to a supported engine version. If you have 4.24 installed, you can manually migrate the project by navigating to the corresponding .uproject file in Windows Explorer, right-clicking it, and selecting the `Switch Unreal Engine version...` option. 
+        The Landscape Mountains project is supported up to Unreal Engine version 4.24. If you do not have 4.24 installed, you should see a dialog titled `Select Unreal Engine Version` with a dropdown to select from installed versions. Select 5.4 to migrate the project to a supported engine version. If you have 4.24 installed, you can manually migrate the project by navigating to the corresponding .uproject file in Windows Explorer, right-clicking it, and selecting the `Switch Unreal Engine version...` option. 
 
 4. From the `File menu` select `New C++ class`, leave default `None` on the type of class, click `Next`, leave default name `MyClass`, and click `Create Class`. We need to do this because Unreal requires at least one source file in project. It should trigger compile and open up Visual Studio solution `LandscapeMountains.sln`.