Updated README file with additional advice building on Linux

This commit is contained in:
samwiddowson 2024-07-09 18:47:51 +01:00 committed by GitHub
parent 349a6b0953
commit 8aa5e9b5ea
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,22 +1,32 @@
**System requirements:**
# Ultimate Doom Builder
## System requirements
- 2.4 GHz CPU or faster (multi-core recommended)
- Windows 7, 8 or 10
- Graphics card with OpenGL 3.2 support
**Required software on Windows:**
### Required software on Windows
- [Microsoft .Net Framework 4.7.2](https://dotnet.microsoft.com/download/dotnet-framework/net472)
**Building on Linux:**
## Building on Linux
These instructions are for Debian-based distros and were tested with Ubuntu 24.04 LTS and Arch.
These instructions are for Debian-based distros and were tested with Ubuntu 24.04 LTS. For others it should be similar.
__Note:__ this is experimental. None of the main developers are using Linux as a desktop OS, so you're pretty much on your own if you encounter any problems with running the application.
__Note:__ this is experimental. None of the developers are using Linux as a desktop OS, so you're pretty much on your own if you encounter any problems with running the application.
- Install Mono. The `mono-complete` package from the Debian repo doesn't include `msbuild`, so you have to install `mono-complete` by following the instructions on the Mono project's website: https://www.mono-project.com/download/stable/#download-lin
- Install additional required packages: `sudo apt install make g++ git libx11-dev libxfixes-dev mesa-common-dev`
- Install Mono
- **Ubuntu:** The `mono-complete` package from the Debian repo doesn't include `msbuild`, so you have to install `mono-complete` by following the instructions on the Mono project's website: https://www.mono-project.com/download/stable/#download-lin
- **Arch:** mono (and msbuild which is also required) is in the *extra/* repo, which is enabled by default. `sudo pacman -S mono mono-msbuild`
- Install additional required packages
- **Ubuntu:** `sudo apt install make g++ git libx11-dev libxfixes-dev mesa-common-dev`
- **Arch:** `sudo pacman -S base-devel`
- If you're using X11 display manager you may need to install these packages: `libx11 libxfixes`
- If you are not using the proprietary nvidia driver you may need to install `mesa`
- Go to a directory of your choice and clone the repository (it'll automatically create an `UltimateDoomBuilder` directory in the current directory): `git clone https://github.com/jewalky/UltimateDoomBuilder.git`
- Compile UDB: `cd UltimateDoomBuilder && make`
- Run UDB: `cd Build && ./builder`
- Alternatively, to compile UDB in debug mode:
- Run `make BUILDTYPE=Debug` in the root project directory
- This includes a debug output terminal in the bottom panel
**Links:**
- [Official thread link](https://forum.zdoom.org/viewtopic.php?f=232&t=66745)