Commit Graph

125 Commits

Author SHA1 Message Date
Max Hilbrunner
eda6a2da1f Compiling for Linux/BSD: Add openKylin
Co-authored-by: DSOE1024 <90103853+DSOE1024@users.noreply.github.com>
2024-11-17 11:56:12 +01:00
Thaddeus Crews
a12dfff799 Bump minimum SCons/Python for builds 2024-11-14 10:01:37 -06:00
tetrapod00
76bcb140d4 Consistently use "built-in" and "built into", avoid "builtin" and "built-in to" 2024-11-08 17:28:29 -08:00
tetrapod00
53ea9b6965 Fix codespell not running on some files 2024-11-06 21:56:26 -08:00
Max Hilbrunner
d92c2cfc99 Merge pull request #10187 from tetrapod00/rubric-headers
Improve display of rubric fake headers with `:heading-level:` option
2024-11-04 00:08:48 +01:00
Hugo Locurcio
47eda9fe60 Mention a way to get development snapshots' source code in Getting the source 2024-11-03 23:39:39 +01:00
tetrapod00
2f634c7acb Improve display of rubric fake headers with heading-level option 2024-11-02 09:42:55 -07:00
Yevhen Babiichuk (DustDFG)
fa25e317ea Update required version of emscripten 2024-10-30 11:56:47 +02:00
Adam Scott
44dfb3a390 Add filenames as captions for code blocks 2024-10-27 16:18:36 -04:00
Hugo Locurcio
4ab397cd5e Document generate_bundle=yes SCons option in Compiling for macOS and iOS
- Reorder instructions to mention ARM64 builds first in macOS,
  as this is the primary architecture in use now (with all new Macs
  since 2023 being sold with Apple Silicon only). The `lipo` command still
  works as before, as it infers the architecture from the input files.
- Remove the manual bundle generation steps to make the page shorter
  (similar to Compiling for Android).
- Remove references to the master branch (this was only relevant when
  4.0 was still in development).
2024-10-16 17:51:52 +02:00
tetrapod00
283fe11715 Improve sidebar navigation by removing headers
- Ensure most pages are reachable through the sidebar, by removing headers on pages that are mostly indexes.
- This also means that some pages now have navigable headers again.
2024-09-23 01:32:56 -07:00
tetrapod00
eb4ab3a78e Clarify requirements in Compiling for Windows 2024-09-21 21:48:59 -07:00
Hugo Locurcio
93261ab5d7 Harmonize Bash command syntax for easier line selection and copy-pasting
- Remove prompt or `$` sign which makes triple-click based selection
  more difficult and time-consuming.
- Use `platform` instead of `p` alias in all SCons examples.
2024-09-15 16:27:34 +02:00
Matthew
aa297fd23c Merge pull request #9862 from MBCX/riscv-cross-compilation
Add compilation instructions for RISC-V
2024-09-07 11:46:34 -04:00
MBCX
2a85b24ec3 Add compilation instructions for RISC-V 2024-09-05 11:00:35 -04:00
Felix Bytow
d68f5ff0cd Mention --no-deprecated in Compiling with .NET 2024-09-04 18:27:25 +02:00
A Thousand Ships
728eb341fa [Contributing] Improve list of classes disabled by disable_advanced_gui 2024-08-28 15:20:16 +02:00
Matthew
b54f912c77 Merge pull request #9582 from russellsanborn/comma-before-but
Add commas before "but" throughout documentation
2024-08-15 21:35:04 -04:00
Fredia Huya-Kouadio
73091bea0a Update the Android build documentation (#9669)
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2024-07-30 08:39:57 +02:00
Gio
18ad4e72f3 Ubuntu APT oneliner to install system builtin alternatives (#9512)
* Ubuntu APT oneliner to install system builtin alternatives

Might work on Debian, not sure - tested on Ubuntu 24.04 LTS

* Use new table syntax (easier to maintain), add Debian

---------

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2024-07-29 00:11:19 +02:00
Max Hilbrunner
08b25ad636 Merge pull request #9650 from bruvzg/win_arm64
Update "Compiling for Windows" page.
2024-07-28 00:07:21 +02:00
skyace65
19ffef34f8 Update Docs for ARM support 2024-07-26 17:48:43 -04:00
bruvzg
cbc0dda137 Update "Compiling for Windows" page. 2024-07-26 10:46:16 +03:00
Joshua Goins
e996398251 Mention single thread web template support (#9392)
* Mention single thread web template support

This is controlled  with the SCons option ``threads``. Now it's documented as another knob you can turn when compiling the web template.

* Update contributing/development/compiling/compiling_for_web.rst

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2024-07-22 16:20:57 +02:00
Max Hilbrunner
6ee50cb3a0 Merge pull request #9568 from Calinou/update-cross-compiling-ios-linux
Update Cross-compiling for iOS on Linux
2024-07-22 16:14:55 +02:00
Hugo Locurcio
71a606fce9 Update Cross-compiling for iOS on Linux
- Update link to Xcode download. Mention that it requires being
  logged into an Apple ID for the page to be visible.
- Remove DMG method as Xcode has been distributed in XIP archives
  since 2016.
2024-07-13 06:31:57 +02:00
Pedro J. Estébanez
d2ccdb5154 Remove references to the no longer needed DXC 2024-07-11 12:32:14 +02:00
Russell Sanborn
5908691ea0 Update contributing/development/compiling/introduction_to_the_buildsystem.rst
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2024-07-09 13:59:04 -05:00
Russell Sanborn
a3e4e9b0cc Add commas before "but" throughout documentation 2024-07-06 08:41:08 -05:00
Hugo Locurcio
e7fdb120c7 Fix dead links in the documentation
Command used:

    lychee **/*.rst --github-token="..." --accept="100..=103,200..=299,429"

429 error codes were allowed due to a high number of false positives,
even with a GitHub token specified.
2024-07-01 18:55:30 +02:00
skyace65
17a683682c Update name of where you get openJDK from 2024-06-28 18:57:55 -04:00
A Thousand Ships
36e2351df2 Fix invalid indentation in various files 2024-06-06 16:16:45 +02:00
Hugo Locurcio
06bd5b3ccb Fix false positives in codespell CI and fix reported typos
- Don't install codespell when building offline docs
  as it's not needed in that workflow.
2024-05-31 10:58:12 +02:00
Aaron Franke
1a7fd1ea5f Improve Compiling for iOS docs: Mention how to set up Xcode 2024-05-29 00:17:25 -07:00
Aaron Franke
e3297dd7cd Improve Compiling for Android docs: Homebrew, GDExtension, terminal 2024-05-29 00:17:25 -07:00
Rémi Verschelde
55f6c52037 Compiling: Min versions are now SCons 3.1.2 and GCC 9 2024-05-17 11:24:51 +02:00
Fredia Huya-Kouadio
91a4273b2c Update the Android documentation for Godot 4.3 2024-05-14 23:32:45 -07:00
Max Hilbrunner
2fbda9eb30 Merge pull request #9357 from Calinou/compiling-for-linuxbsd-update-deps
Update dependencies in Compiling for Linux/*BSD
2024-05-12 12:53:34 +02:00
Aaron Franke
97e34daba4 Fix meaning of "scons" by itself in Introduction to the Buildsystem 2024-05-11 18:14:08 -07:00
Hugo Locurcio
27f9076302 Update dependencies in Compiling for Linux/*BSD
- List Wayland dependency and packages on most distributions.
- Use `sudo` on distributions that are set up to use it by default.
- Use unattended install-friendly commands (e.g. `-y` switch).
- Mention required commands to run before installing, such as
  `apt-get update`.
- Fix install commands on some distributions:
  - Alpine no longer packages libexecinfo since 3.17, so it was removed
    from the list.
  - Solus requires `-c` for `system.devel`.
- Reorder distributions so they're in alphabetical order.
2024-05-11 00:05:57 +02:00
Paul Joannon
f300b404bb Update required SDK version on "compiling w/ .NET" 2024-04-23 23:31:34 +02:00
Mikael Hermansson
3279f8a8a8 Update the names of the export binaries 2024-04-17 12:26:18 +02:00
Christen Lofland
4b47a47de0 Simplify the MSVC install instructions
This line can be simplified from:
`If installing Visual Studio 2017 or 2019, make sure to enable **C++** in
the list of workflows to install.`
To:
`Make sure to enable **C++** in the list of workflows to install.`

This line is not needed as we don't support 2015 anymore:
`If installing Visual Studio 2015, make sure to run a **Custom**
installation instead of **Typical** and select **C++** as a language there.`

This can be simplified from:
`If you've already made the mistake of installing Visual Studio without
C++ support, run the installer again; it should present you a **Modify** button.`
To:
`If you've already installed Visual Studio without C++ support, run the installer
again; it should present you a **Modify** button.`

From my checking on my system, this line is no longer true, so we can remove it:
`Running the installer from *Add/Remove Programs* will only give you
a **Repair** option, which won't let you install C++ tools.`

Now we can move the simplified text up so that the reader does not have to dig through the entire document to find that important bit of information, while not making the text at the top much longer due removing outdated information.
2024-04-11 10:22:27 -05:00
A Thousand Ships
bd6cc665a7 Fix incorrect uses of a/an 2024-03-29 15:14:27 +01:00
Matthew
809e728db0 Merge pull request #8983 from Calinou/compiling-for-linuxbsd-production
Clarify `production=yes` SCons option in Compiling for Linux/*BSD
2024-03-13 19:33:57 -04:00
A Thousand Ships
54a8d084bf [Navigation] Document 3D support is required for navigation 2024-03-06 15:45:22 +01:00
Hugo Locurcio
a5649f0a4b Clarify production=yes SCons option in Compiling for Linux/*BSD 2024-03-05 19:37:08 +01:00
Matthew
4f21f44632 Merge pull request #8743 from akien-mga/scons-cmdline-CCFLAGS-lowercase
Rename SCons command line options for CCFLAGS, etc. to lowercase
2024-02-22 20:26:08 -05:00
Fabio Alessandrelli
712aa0c345 [Web] Expand "Interacting with Javascript"
Document the new (preferred) interface.

Add a small section about downloading files to the user device.
2024-02-21 11:45:33 +01:00
Matthew
e31543bb83 Merge pull request #8863 from DSOE1024/patch-1
Update compiling_for_linuxbsd.rst Added a description that compiling for RISC-V devices
2024-02-11 08:52:45 -05:00