From 08042ad25a81f8a04538901aba886c8299414cc7 Mon Sep 17 00:00:00 2001
From: Roy <roy15957@gmail.com>
Date: Tue, 22 Oct 2024 02:04:23 +0300
Subject: [PATCH] Add the installation guide for ubuntu 22.04,24.04

---
 docs/getting-started.md | 52 ++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 51 insertions(+), 1 deletion(-)

diff --git a/docs/getting-started.md b/docs/getting-started.md
index 8ce189bc..41a2be11 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -47,7 +47,57 @@ Try driving the car around using the arrowkeys.
 If you get a black screen with some buttons, make sure the folder with the binary is in your user folder (Windows: `C:\Users\username\Formula-Student-Driverless-Simulator`, Linux: `~/Formula-Student-Driverless-Simulator`)
 
 If all that works, you can continue to [the ROS interface](getting-started-with-ros.md) or [the python interface](getting-started-with-python.md).
-### From source using the Unreal Engine Editor
+
+### Building from source using the Unreal Engine Editor and Ubuntu 20.04,22.04+
+This guide outlines the steps for building the project from source on Ubuntu 20.04 and 22.04. It should also work for Ubuntu 24.04+, although this has not yet been tested.
+
+**Written by Roy Amoyal, Head of the Autonomous Division at BGRacing 2024 (Formula Student Driverless Project at Ben Gurion University)**
+
+#### Build AirSim
+##### For Ubuntu 20.04
+
+    cd /home/YOUR_USER/Formula-Student-Driverless-Simulator/AirSsim
+    cp ./docker_build/setup.sh .
+    cp ./docker_build/build.sh .
+    ./setup.sh && ./build.sh
+
+##### For Ubuntu 22.04+
+First, install Docker on your Ubuntu system.
+
+Change to the Docker Build Directory: Note that this directory is within the AirSim folder, not the root of the Formula-Student-Driverless-Simulator repository.
+
+    cd /home/YOUR_USER/Formula-Student-Driverless-Simulator/AirSim/docker_build
+
+1. Build the Docker Image:
+
+        docker build -t formula-simulator .
+
+2. Run the Docker Container: After the build completes, mount your local folder into the container:
+
+        
+        docker run --rm -it -v /home/YOUR_USER/Formula-Student-Driverless-Simulator:/home/airsim/Formula-Student-Driverless-Simulator formula-simulator
+
+
+3. Inside the Container: Copy the modified setup.sh and build.sh scripts:
+
+        cp ./docker_build/setup.sh .
+        cp ./docker_build/build.sh .
+
+4. Run the Setup and Build:
+
+       ./setup.sh && ./build.sh
+
+5. Exit the Docker Container: Press Ctrl + D in the terminal to exit.
+
+6. Build the final project, use the following command (this process may take some time):
+
+       ~/UnrealEngine/Engine/Binaries/ThirdParty/Mono/Linux/bin/mono ~/UnrealEngine/Engine/Binaries/DotNET/UnrealBuildTool.exe Development Linux -Project=/home/YOUR_USER/Formula-Student-Driverless-Simulator/UE4Project/FSOnline.uproject -TargetType=Editor -Progress
+
+Congratulations! You have successfully built the project from source. You can now open and edit the project by running:
+
+    ./home/YOUR_USERNAME/Formula-Student-Driverless-Simulator/UE4Project/FSOnline.uproject
+
+### Building from source using the Unreal Engine Editor for earlier versions of Ubuntu (e.g., Ubuntu 18.04)
 Instead of running the simulator from release binaries, you can compile it manually using unreal engine.
 This is usefull if you want to get the latest changes or if you want to make changes to the maps or the simulation itself.
 If you want to run the unreal engine project from source you will need [unreal engine and visual studio 2019](software-install-instructions.md).