From a41e85f8e95a37551a8f2e5584fac8752b868ba4 Mon Sep 17 00:00:00 2001 From: Relintai Date: Sun, 29 Sep 2024 21:07:54 +0200 Subject: [PATCH] Cleaned up the 01_getting_source section. --- .../01_compiling/01_getting_source.md | 21 +++++++++---------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/05_engine_development/01_compiling/01_getting_source.md b/05_engine_development/01_compiling/01_getting_source.md index fd33268..ba615bb 100644 --- a/05_engine_development/01_compiling/01_getting_source.md +++ b/05_engine_development/01_compiling/01_getting_source.md @@ -3,18 +3,18 @@ ## Downloading the Pandemonium source code -Before `getting into the SCons build system ( doc_introduction_to_the_buildsystem )` +Before [getting into the SCons build system](02_introduction_to_the_buildsystem.md) and compiling Pandemonium, you need to actually download the Pandemonium source code. -The source code is available on `GitHub ( https://github.com/Relintai/pandemonium_engine )` +The source code is available on [GitHub](https://github.com/Relintai/pandemonium_engine) and while you can manually download it via the website, in general you want to do it via the `git` version control system. If you are compiling in order to make contributions or pull requests, you should -follow the instructions from the `Pull Request workflow ( doc_pr_workflow )`. +follow the instructions from the [Pull Request workflow](../../06_community/contributing/04_pr_workflow.md). If you don't know much about `git` yet, there are a great number of -`tutorials ( https://git-scm.com/book )` available on various websites. +[tutorials](https://git-scm.com/book) available on various websites. In general, you need to install `git` and/or one of the various GUI clients. @@ -26,11 +26,12 @@ the following in a terminal: ``` git clone https://github.com/Relintai/pandemonium_engine.git + # You can add the --depth 1 argument to omit the commit history. # Faster, but not all Git operations (like blame) will work. ``` -For any stable release, visit the `release page ( https://github.com/Relintai/pandemonium_engine/releases )` +For any stable release, visit the [release page](https://github.com/Relintai/pandemonium_engine/releases) and click on the link for the release you want. You can then download and extract the source from the download link on the page. @@ -38,14 +39,12 @@ With `git`, you can also clone a stable release by specifying its branch or tag after the `--branch` (or just `-b`) argument: ``` -# Clone the continuously maintained stable branch (`3.x` as of writing). -git clone https://github.com/Relintai/pandemonium_engine.git -b 3.x - -# Clone the `3.2.3-stable` tag. This is a fixed revision that will never change. -git clone https://github.com/Relintai/pandemonium_engine.git -b 3.2.3-stable +# Clone the `v4.5.0` tag. This is a fixed revision that will never change. +git clone https://github.com/Relintai/pandemonium_engine.git -b v4.5.0 ``` There are also generally branches besides `master` for each major version. After downloading the Pandemonium source code, -you can `continue to compiling Pandemonium ( doc_introduction_to_the_buildsystem )`. +you can [continue to compiling Pandemonium](02_introduction_to_the_buildsystem.md). +