From 6c52a89675d9b2d3cbd8462430ead294da6a11da Mon Sep 17 00:00:00 2001 From: Alireza Ghaderi Date: Mon, 26 Aug 2024 04:55:25 +0000 Subject: [PATCH 1/3] Update v2.md --- docs/v2.md | 27 +++++++++++---------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/docs/v2.md b/docs/v2.md index 5a52ad9..a815812 100644 --- a/docs/v2.md +++ b/docs/v2.md @@ -20,7 +20,7 @@ Watch full setup guide and demonstration on YouTube: [PX4 X-Plane Plugin Tutoria Download X-Plane 11 or 12 from the [X-Plane Official Website](https://www.x-plane.com/download/). 2. **eVTOL Air Taxi (eHang 184)** - You can download the eVTOL Air Taxi (eHang 184) from the [X-Plane Forum](https://forums.x-plane.org/index.php?/files/file/76635-quadricopter-piloted/), though it's no longer required as the script supports multiple airframes. + You can download the eVTOL Air Taxi (eHang 184) from the [X-Plane Forum](https://forums.x-plane.org/index.php?/files/file/76635-quadricopter-piloted/), though it's no longer required as the script supports multiple default airframes already available in X-Plane. 3. **QGroundControl** Download QGroundControl from the [Official Download Page](https://docs.qgroundcontrol.com/master/en/getting_started/download_and_install.html). @@ -47,33 +47,28 @@ WSL2 (Windows Subsystem for Linux) allows you to run a Linux environment directl **Note:** The script is optimized for WSL but works on Linux too. ---- - ## Clone and Build PX4 ### Quick Setup Using the Automated Script -To use the automated setup script, follow these steps: +To quickly set up PX4 with X-Plane using WSL (Ubuntu 22.04), follow this simple step: -1. Open your terminal and change the directory to your home directory: - - ```bash - cd ~ - ``` +1. **Run the setup script directly from your terminal:** -2. Download the setup script using `curl`: + First, make sure you are in your WSL Ubuntu terminal (launch it from PowerShell), then enter the following command in your WSL terminal: ```bash - curl -O https://raw.githubusercontent.com/alireza787b/px4xplane/master/setup/setup_px4_sitl.sh + cd ~ && curl -O https://raw.githubusercontent.com/alireza787b/px4xplane/master/setup/setup_px4_sitl.sh && bash setup_px4_sitl.sh ``` -3. Run the setup script: + This command will automatically download and run the setup script from the specified URL. - ```bash - bash ./setup_px4_sitl.sh - ``` +### Important Notes: + +- **Time Required**: The installation process may take some time, depending on your system and configuration, especially the first time. +- **Prompts**: During installation, you will encounter several prompts asking you to customize the setup. You can either read and decide on each prompt or just let the defaults take effect (the script will automatically proceed with default settings if you don't respond). -4. Once setup is complete, use the `px4xplane` command to run the simulation from anywhere in your terminal. +2. Once setup is complete, use the `px4xplane` command to run the simulation from anywhere in your terminal. ### Manual Build and Run (If you dont want to use automated script) From 31f155fb22bb2da702c30770fbdf4c325907c884 Mon Sep 17 00:00:00 2001 From: Alireza Ghaderi Date: Mon, 26 Aug 2024 04:56:14 +0000 Subject: [PATCH 2/3] Update README.md --- README.md | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 9c80dad..90a9ad5 100644 --- a/README.md +++ b/README.md @@ -55,27 +55,22 @@ For full step-by-step instructions, follow the [Version 2 Documentation](https:/ This automated script is optimized for using with **WSL** (Windows Subsystem for Linux), where X-Plane runs on Windows, and PX4 SITL runs on Linux (WSL). It should also work natively on Ubuntu and other Linux distributions. -1. Open your terminal and enter your WSL terminal. Then change the directory to your home directory: +To quickly set up PX4 with X-Plane using WSL (Ubuntu 22.04), follow this simple step: - ```bash - cd ~ - ``` +1. **Run the setup script directly from your terminal:** -2. Download the setup script using `curl`: + First, make sure you are in your WSL Ubuntu terminal (launch it from PowerShell), then enter the following command in your WSL terminal: ```bash - curl -O https://raw.githubusercontent.com/alireza787b/px4xplane/master/setup/setup_px4_sitl.sh + cd ~ && curl -O https://raw.githubusercontent.com/alireza787b/px4xplane/master/setup/setup_px4_sitl.sh && bash setup_px4_sitl.sh ``` -3. Run the setup script: - - ```bash - bash ./setup_px4_sitl.sh - ``` - Follow Instruction and select the platform you want to run. +### Important Notes: -Once default setup is complete, use the `px4xplane` command to run the simulation from anywhere in your terminal. +- **Time Required**: The installation process may take some time, depending on your system and configuration, especially the first time. +- **Prompts**: During installation, you will encounter several prompts asking you to customize the setup. You can either read and decide on each prompt or just let the defaults take effect (the script will automatically proceed with default settings if you don't respond). +2. Once setup is complete, use the `px4xplane` command to run the simulation from anywhere in your terminal. ### Uninstall To remove the global paths and the `px4xplane` command: From 4aa001a322ec092e3e58fbe4949ce7c96d02e595 Mon Sep 17 00:00:00 2001 From: Alireza Ghaderi Date: Mon, 26 Aug 2024 04:56:39 +0000 Subject: [PATCH 3/3] Update v2.md --- docs/v2.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/v2.md b/docs/v2.md index a815812..11492bb 100644 --- a/docs/v2.md +++ b/docs/v2.md @@ -61,8 +61,6 @@ To quickly set up PX4 with X-Plane using WSL (Ubuntu 22.04), follow this simple cd ~ && curl -O https://raw.githubusercontent.com/alireza787b/px4xplane/master/setup/setup_px4_sitl.sh && bash setup_px4_sitl.sh ``` - This command will automatically download and run the setup script from the specified URL. - ### Important Notes: - **Time Required**: The installation process may take some time, depending on your system and configuration, especially the first time.