From cea05b0b360ae70a2973c6070fe1c6b19f8e2e6c Mon Sep 17 00:00:00 2001 From: Stepland <10530295-Buggyroom@users.noreply.gitlab.com> Date: Fri, 2 Aug 2024 23:47:26 +0200 Subject: [PATCH] fix docs --- docs/Compiling.md | 17 ++++++++++------- docs/Releases.md | 8 ++++---- docs/Setup.md | 4 ++-- 3 files changed, 16 insertions(+), 13 deletions(-) diff --git a/docs/Compiling.md b/docs/Compiling.md index edfed72..f8a4851 100644 --- a/docs/Compiling.md +++ b/docs/Compiling.md @@ -13,16 +13,19 @@ In other words, how to create a new F.E.I.S. executable from the source code. 0. Setup a build directory called `build` ```console - $ meson setup build + $ meson setup build (options) ``` - - If you are compiling for a release and not a debug build, use `--buildtype=release` + + Options include : + + `--buildtype=release` If you are compiling for a release and not a debug build - If you want to compile the unit tests as well, pass in `-D tests=true`. - You can also set this option later by doing : + `-D tests=true` If you want to compile the unit tests + + You can also set options later by doing : ```console - $ meson configure build -D tests=true + $ meson configure build (options) ``` 0. Compile in that directory @@ -35,4 +38,4 @@ In other words, how to create a new F.E.I.S. executable from the source code. ```console $ ln -s ../assets build/assets - ``` \ No newline at end of file + ``` diff --git a/docs/Releases.md b/docs/Releases.md index 6d7b348..01993cd 100644 --- a/docs/Releases.md +++ b/docs/Releases.md @@ -13,20 +13,20 @@ 1. Pull the release tag 1. Follow the [compilation instructions](Compiling.md) -1. Open an MSYS2 x64 terminal +1. Open an MSYS2 UCRT64 terminal 1. `cd` into FEIS's source code root 1. Use the release making script For a regular semver release ```console - $ python utils/make_windows.release.py --release-version 2.x.x + $ python utils/make_windows_release.py ``` For preview builds ```console - $ python utils/make_windows.release.py --release-version 2.x.x-alpha --timestamp + $ python utils/make_windows_release.py --timestamp ``` 1. Distribute the generated `.zip` file @@ -52,4 +52,4 @@ ```console $ ./build_deb.sh ../../build_release/FEIS ../../assets/ ../../images/feis\ icon.svg ``` -1. Distribute the generated `.deb` file, found in the `packaging/debian/package` folder \ No newline at end of file +1. Distribute the generated `.deb` file, found in the `packaging/debian/package` folder diff --git a/docs/Setup.md b/docs/Setup.md index e273252..dab29ea 100644 --- a/docs/Setup.md +++ b/docs/Setup.md @@ -57,7 +57,7 @@ at build systems and would be delighted to learn from an expert) Installing MSYS2 is pretty simple. [Follow their instructions](https://www.msys2.org/) Once you're done `pacman -Syu`ing and `pacman -Su`ing your system, open a new -`MSYS2 MSYS` terminal and install the required packages : +`MSYS2 UCRT64` terminal and install the required packages : ```console $ pacman -S \ @@ -71,5 +71,5 @@ $ pacman -S \ mingw-w64-ucrt-x86_64-mpdecimal ``` -Once this is done, open a new `MSYS2 MinGW x64` terminal and follow the +Once this is done, open a new `MSYS2 UCRT64` terminal and follow the [compilation instructions](Compiling.md)