Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update build guide #7167

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ZhiZe-ZG
Copy link
Contributor

Update build guide about compiling for Windows via MinGW on Linux:

  • Added hints about system version.
  • Added relevant reference information and links.
  • Formatting and linting.

The old guide did not mention the Ubuntu version. The current compilation environment (of .github/workflows) has not been upgraded to Ubuntu 24.

Comment on lines +149 to +151
This section is about compiling binary executables for Windows on a Linux system host via [MinGW](https://www.mingw-w64.org/). It's not about compiling for Windows on a Windows host via MinGW. So you first need a Linux system host. If you don't, you can also try WSL (Windows Subsystem for Linux) on Windows.

If you have any problems with the build process, please refer to the configuration files in the `.github/workflows` folder. These files are automatically executed by the [GitHub Actions](https://docs.github.com/en/actions) service to automate the build. Under the environment described by these configuration files, the compilation is more likely to succeed.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This section is about compiling binary executables for Windows on a Linux system host via [MinGW](https://www.mingw-w64.org/). It's not about compiling for Windows on a Windows host via MinGW. So you first need a Linux system host. If you don't, you can also try WSL (Windows Subsystem for Linux) on Windows.
If you have any problems with the build process, please refer to the configuration files in the `.github/workflows` folder. These files are automatically executed by the [GitHub Actions](https://docs.github.com/en/actions) service to automate the build. Under the environment described by these configuration files, the compilation is more likely to succeed.
This section details how to compile a Windows executable using [MinGW](https://www.mingw-w64.org/) on a Linux system, not on a Windows system. If you are using Windows, you can use WSL (Windows Subsystem for Linux) to accomplish this.


```
```bash
# Only tested on Ubuntu 22. This won't work on Ubuntu 24 (they are renamed in Ubuntu 24).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Only tested on Ubuntu 22. This won't work on Ubuntu 24 (they are renamed in Ubuntu 24).
# Only tested on Ubuntu 22.04

This is still the command for these on 24.04


```
```bash
# Only tested on Ubuntu 22. This won't work on Ubuntu 24 (they are renamed in Ubuntu 24).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Only tested on Ubuntu 22. This won't work on Ubuntu 24 (they are renamed in Ubuntu 24).
# Only tested on Ubuntu 22.04

This is still the command for these on 24.04

@@ -173,22 +181,30 @@ cd devilutionx

### Installing dependencies on WSL, Debian and Ubuntu

The following compilation process has been tested on `ubuntu-22.04`. Success is not guaranteed on Linux distributions other than Ubuntu 22.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The following compilation process has been tested on `ubuntu-22.04`. Success is not guaranteed on Linux distributions other than Ubuntu 22.
The following compilation process has been tested on `ubuntu-22.04`. Success is not guaranteed on Linux distributions other than Ubuntu 22.04

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ZhiZe-ZG Ubuntu's version are YY.MM, there is one every 6 month, and a long term every 2 years.

23.10 = October 2023
24.04 LTS = April 2024
24.10 = October 2024
...
26.04 LTS = April 2026

So that's why the minor version (month) is important to include and not just the major (year).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants