Some updates to development docs

iNavFlight · Mar 23, 2024 · 839f7c0 · 839f7c0
1 parent 2b1df9e
commit 839f7c0
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 0 deletions.
diff --git a/docs/development/Building in Docker.md b/docs/development/Building in Docker.md
@@ -1,5 +1,7 @@
 # Building with Docker
 
+> **On Windows building with this method is not advised and should be used only if Windows Linux Subsystem can not be used. In all other cases all Windows users should be using Linux Subsystem (WSL) instead**
+
 Building with [Docker](https://www.docker.com/) is remarkably easy: an isolated container will hold all the needed compilation tools so that they won't interfere with your system and you won't need to install and manage them by yourself. You'll only need to have Docker itself [installed](https://docs.docker.com/install/).
 
 The first time that you'll run a build it will take a little more time than following executions since it will be building its base image first. Once this initial process is completed, the firmware will be always built immediately.

diff --git a/docs/development/Building in Vagrant.md b/docs/development/Building in Vagrant.md
@@ -1,5 +1,7 @@
 # Building with Vagrant
 
+> **On Windows building with this method is not advised and should be used only if Windows Linux Subsystem can not be used. In all other cases all Windows users should be using Linux Subsystem (WSL) instead**
+
 Setting up build environment with Vagrant is remarkably simple, but you still need to have some basic knowlage of your OS.
 
 ## Installing Vagrant

diff --git a/docs/development/Building in Windows 10 or 11 with MSYS2.md b/docs/development/Building in Windows 10 or 11 with MSYS2.md
@@ -1,4 +1,7 @@
 # Building in Windows with MSYS2
+
+> **Building with this method is not advised and should be used only if Windows Linux Subsystem can not be used. In all other cases all Windows users should be using Linux Subsystem (WSL) instead**
+
 - This environment does not require installing WSL, which may not be available or would get in the way of other virtualization and/or anti-cheat software
 - It is also much faster to install and get set up because of its small size(~3.65 GB total after building hex file as of 6.0.0)
 ## Setting up the environment

diff --git a/.../development/Building in Windows light.md → ...[Deprecated] Building in Windows light.md b/.../development/Building in Windows light.md → ...[Deprecated] Building in Windows light.md
@@ -1,4 +1,8 @@
 # Building in windows light [Deprecated]
+
+> **Building with this method is deprecated and not advised. All Windows users should be using
+Linux Subsystem (WSL) instead**
+
 no cygwin and no path changes
 
 ## Install Git for windows