From 839f7c0fd05af05fbd74ef17fb86368e5d890dd2 Mon Sep 17 00:00:00 2001 From: "Pawel Spychalski (DzikuVx)" Date: Sat, 23 Mar 2024 12:33:04 +0100 Subject: [PATCH] Some updates to development docs --- docs/development/Building in Docker.md | 2 ++ docs/development/Building in Vagrant.md | 2 ++ docs/development/Building in Windows 10 or 11 with MSYS2.md | 3 +++ ...ows light.md => [Deprecated] Building in Windows light.md} | 4 ++++ 4 files changed, 11 insertions(+) rename docs/development/{Building in Windows light.md => [Deprecated] Building in Windows light.md} (96%) diff --git a/docs/development/Building in Docker.md b/docs/development/Building in Docker.md index 575614a95d1..fe3723359f4 100755 --- 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 index 99d479b7c19..c931f2ffcca 100644 --- 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 index 2d7f967b505..bc55be7410d 100644 --- 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/docs/development/Building in Windows light.md b/docs/development/[Deprecated] Building in Windows light.md similarity index 96% rename from docs/development/Building in Windows light.md rename to docs/development/[Deprecated] Building in Windows light.md index e05b2c92f3b..de4659e7455 100644 --- a/docs/development/Building in Windows light.md +++ b/docs/development/[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