From a0d8d885d9dff365e2a99e691ef3405d874feb08 Mon Sep 17 00:00:00 2001 From: Relintai Date: Fri, 7 Apr 2023 00:05:12 +0200 Subject: [PATCH] Cleaned up the Introduction to the buildsystem section. --- .../introduction_to_the_buildsystem.md | 66 ++++++------------- 1 file changed, 20 insertions(+), 46 deletions(-) diff --git a/development/compiling/introduction_to_the_buildsystem.md b/development/compiling/introduction_to_the_buildsystem.md index f98b84b..3511432 100644 --- a/development/compiling/introduction_to_the_buildsystem.md +++ b/development/compiling/introduction_to_the_buildsystem.md @@ -1,11 +1,7 @@ +# Introduction to the buildsystem -Introduction to the buildsystem -=============================== - - -SCons ------ +## SCons Godot uses `SCons ( https://www.scons.org/ )` to build. We love it, we are not changing it for anything else. We are not even sure other build @@ -35,8 +31,7 @@ other alternatives, for example: So, please try to keep an open mind and get at least a little familiar with it if you are planning to build Godot yourself. -Setup ------ +## Setup Please refer to the documentation for `doc_compiling_for_android`, `doc_compiling_for_ios`, `doc_compiling_for_osx`, @@ -47,8 +42,7 @@ Note that for **Windows/Visual Studio**, you need to use `x86_x64 Cross Tools Command Prompt for VS 2017` or similar, depending on your install, instead of the standard Windows command prompt to enter the commands below. -Platform selection ------------------- +## Platform selection Godot's build system will begin by detecting the platforms it can build for. If not detected, the platform will simply not appear on the list of @@ -93,8 +87,8 @@ Example for using 4 cores: scons platform=x11 -j 4 ``` -Resulting binary ----------------- +## Resulting binary + The resulting binaries will be placed in the `bin/` subdirectory, generally with this naming convention: @@ -130,9 +124,7 @@ Aside from that, there are a few standard options that can be set in all build targets, and which will be explained below. - -Tools ------ +## Tools Tools are enabled by default in all PC targets (Linux, Windows, macOS), disabled for everything else. Disabling tools produces a binary that can @@ -143,9 +135,7 @@ manager. scons platform= tools=yes/no ``` - -Target ------- +## Target Target controls optimization and debug flags. Each mode means: @@ -167,8 +157,7 @@ This flag appends the `.debug` suffix (for debug), or `.tools` (for debug with tools enabled). When optimization is enabled (release), it appends the `.opt` suffix. -Bits ----- +## Bits Bits is meant to control the CPU or OS version intended to run the binaries. It is focused mostly on desktop platforms and ignored everywhere @@ -186,10 +175,7 @@ This flag appends `.32` or `.64` suffixes to resulting binaries when relevant. If `bits=default` is used, the suffix will match the detected architecture. - - -Custom modules --------------- +## Custom modules It's possible to compile modules residing outside of Godot's directory tree, along with the built-in modules. @@ -218,8 +204,7 @@ See also: `doc_custom_modules_in_c++` -Cleaning generated files ------------------------- +## Cleaning generated files Sometimes, you may encounter an error due to generated files being present. You can remove them by using `scons --clean