[doc] Windows install + some fixes

paparazzi · Jan 25, 2024 · 9d99bae · 9d99bae
1 parent 829eab2
commit 9d99bae
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/doc/sphinx/source/getting_started/install.rst b/doc/sphinx/source/getting_started/install.rst
@@ -6,6 +6,8 @@ Installation
 
 Paparazzi runs best on **Ubuntu 16.04 or higher**, so this quick installation guide is for Ubuntu users.
 
+If you want to run it on windows, see the instructions: `Install on Windows`_.
+
 Open a terminal and execute each lines below. If one fails, ask for help on gitter.
 
 Version specific prerequisites
@@ -72,3 +74,23 @@ Finally, launch Paparazzi with
     ./paparazzi
 
 If all went well the Paparazzi Center should now be running. Please continue to the next page for a guided tour.
+
+Install on Windows
+------------------
+
+Paparazzi do not run natively on windows, but you can run it in the *Windows Subsystem for Linux*.
+
+Install the Windows Subsystem for Linux and the Ubuntu distribution by following the Microsoft documentation,
+then install paparazzi like on a regular Ubuntu.
+
+In older versions of WLS, you may need to install an X server like `VcXsrv <https://sourceforge.net/projects/vcxsrv/>`_
+or `Xming <https://sourceforge.net/projects/xming/>`_.
+You will then need to set the *DISPLAY* environment variable to point at the X server running on your Windows 10 PC :
+
+.. code-block:: bash
+
+    export DISPLAY=$(cat /etc/resolv.conf | grep nameserver | awk '{print $2; exit;}'):0
+
+.. note::
+
+    The **Windows Terminal** application is very usefull as it can have multiple tabs and allows you to easily switch between Bash and Powershell.
diff --git a/doc/sphinx/source/getting_started/paparazzi_center_tour.rst b/doc/sphinx/source/getting_started/paparazzi_center_tour.rst
@@ -36,15 +36,15 @@ Once the aircraft is configured, the firmware can be build for a target.
 
 Some usual targets are:
 
-- **sim**: The basic fixedwing simulator written in OCaml without IMU simulation or any sensor models (noise, bias, etc) and mainly intended to validate your flight plan logic.
+- **sim**: This basic fixedwing simulator has no IMU simulation or any sensor models (noise, bias, etc) and is mainly intended to validate your flight plan logic.
 - **nps**: NPS is a more advanced rotorcraft and fixedwing simulator with sensor models and commonly uses JSBSim as FDM (Flight Dynamic Model).
 - **ap**: This is for a *real* autopilot.
 
 
 If the selected target is not a simulator, you can choose how you want to upload the
 firmware to your autopilot, then flash it.
 
-Compilation output is shown in the console zone.
+Compilation output is shown in the console below.