SquareGameLiberationFront/F.E.I.S
1
0
Fork 0
mirror of https://gitlab.com/square-game-liberation-front/F.E.I.S.git synced 2024-09-23 19:18:28 +02:00
Code Releases Wiki Activity

fix docs

Browse Source
This commit is contained in:
Stepland 2024-08-02 23:47:26 +02:00
parent 03956399ec
commit cea05b0b36
3 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/Compiling.md
View File

@ -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
```
```

8
docs/Releases.md
View File

@ -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
1. Distribute the generated `.deb` file, found in the `packaging/debian/package` folder

4
docs/Setup.md
View File

@ -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)