From f9aae169498f012084dc42d97e5902b403a6b20c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Hrdli=C4=8Dka?= Date: Thu, 26 Nov 2020 23:08:20 +0100 Subject: [PATCH] Create buildguide.rst --- dev/buildguide.rst | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 dev/buildguide.rst diff --git a/dev/buildguide.rst b/dev/buildguide.rst new file mode 100644 index 0000000..dfd922d --- /dev/null +++ b/dev/buildguide.rst @@ -0,0 +1,38 @@ +Build guide +=========== +In order to compile 86Box, please follow this step-by-step guide: + +1. Install the [MSYS2](https://www.msys2.org/) environment. The rest of the guide will refer to the directory that you install it to (`C:\msys32` or `C:\msys64` by default) as the MSYS2 root. + +2. Launch your MSYS2 environment using the `MSYS2 MinGW 32-bit` shortcut. If you do not want to use the shortcut, launch it using the `mingw32.exe` executable in the MSYS2 root. + +3. Once launched, you should update the environment: + ```console + $ pacman -Syu + ``` + You may need to do this twice, just follow the on-screen instructions. Make sure you re-run the command periodically to keep the environment up-to-date. + +4. Run the following command to install all of the dependencies: + ```console + $ pacman -S gdb make git mingw-w64-i686-toolchain mingw-w64-i686-openal mingw-w64-i686-freetype mingw-w64-i686-SDL2 mingw-w64-i686-zlib mingw-w64-i686-libpng + ``` + +5. Once the environment is fully updated and all dependencies are installed, change directory to `src`: + ```console + $ cd path/to/86Box/src + ``` + +6. Start the actual compilation process: + ```console + $ make -f win/Makefile.mingw + ``` + By default, `make` does not run in parallel. If you want it to use more threads, use the `-j` switch with the number of threads, e.g. `-j4`. However, keep in mind that you should not exceed your thread (logical processor) count, since that just uses more resources for little to no gain. + +7. If the compilation succeeded (which it almost always should), you will find `86Box.exe` in the `src` directory. + +8. In order to test your fresh build, replace the `86Box.exe` in your current 86Box environment with your freshly built one. If you do not have a pre-existing 86Box environment, download the latest successful build from http://ci.86box.net, and the latest ROM set from https://github.com/86Box/roms. + +9. Enjoy using and testing the emulator! :) + +If you encounter issues at any step or have additional questions, please join +the IRC channel or the appropriate channel on our Discord server and wait patiently for someone to help you.