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 1/6] 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. From 510870c9d95f11e20286b6d521c0f87102a0ac87 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Hrdli=C4=8Dka?= Date: Thu, 26 Nov 2020 23:08:44 +0100 Subject: [PATCH 2/6] Update index.rst --- index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/index.rst b/index.rst index 2e8c07e..e36b59d 100644 --- a/index.rst +++ b/index.rst @@ -45,5 +45,6 @@ Contents :maxdepth: 1 :caption: Development + dev/buildguide dev/builds dev/formats/index From a83a35a091d48ab725865affe643008c1523921e Mon Sep 17 00:00:00 2001 From: Ben Date: Wed, 9 Dec 2020 09:16:48 +1100 Subject: [PATCH 3/6] Update Take screenshot Lacked clarity as to the location of the screenshots directory. https://github.com/86Box/86Box/issues/1163 --- usage/menubar.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/usage/menubar.rst b/usage/menubar.rst index 08f7c47..4a89d35 100644 --- a/usage/menubar.rst +++ b/usage/menubar.rst @@ -53,7 +53,7 @@ Tools .. note:: Discord integration will not be available if the Discord desktop app is not running, or if the included ``discord_game_sdk.dll`` file is missing from the 86Box directory. -* **Take screenshot:** take a screenshot of the emulated display. Screenshots are saved as PNG images in the ``screenshots`` directory. +* **Take screenshot:** take a screenshot of the emulated display. Screenshots are saved as PNG images in the ``screenshots`` subdirectory found in each virtual machine's configuration folder. Help ---- From 48d66f744bbf5e78ca8e1f1c182a8d07eb30bd36 Mon Sep 17 00:00:00 2001 From: Daniel Gurney Date: Sun, 13 Jun 2021 17:39:51 +0300 Subject: [PATCH 4/6] Fix build guide formatting --- dev/buildguide.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/dev/buildguide.rst b/dev/buildguide.rst index dfd922d..c945169 100644 --- a/dev/buildguide.rst +++ b/dev/buildguide.rst @@ -2,35 +2,35 @@ 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. +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. +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 https://ci.86box.net, and the latest ROM set from https://github.com/86Box/roms. 9. Enjoy using and testing the emulator! :) From 036bacdc582d050d4d42ea869ea72c24b4ed4696 Mon Sep 17 00:00:00 2001 From: Daniel Gurney Date: Sun, 13 Jun 2021 17:54:35 +0300 Subject: [PATCH 5/6] Actually fix the build guide formatting --- dev/buildguide.rst | 38 ++++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/dev/buildguide.rst b/dev/buildguide.rst index c945169..bd8baad 100644 --- a/dev/buildguide.rst +++ b/dev/buildguide.rst @@ -2,37 +2,39 @@ 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. +1. Install the `MSYS2 `_ 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: - `` - $ pacman -Syu - `` + .. code-block:: bash + + $ 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: - `` - $ 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 - `` + .. code-block:: bash + + $ 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`: - `` - $ cd path/to/86Box/src - `` +5. Once the environment is fully updated and all dependencies are installed, change directory to ``src``: + .. code-block:: bash + + $ cd path/to/86Box/src 6. Start the actual compilation process: - `` - $ 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. + .. code-block:: bash -7. If the compilation succeeded (which it almost always should), you will find `86Box.exe` in the `src` directory. + $ 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. -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 https://ci.86box.net, and the latest ROM set from https://github.com/86Box/roms. +8. If the compilation succeeded (which it almost always should), you will find ``86Box.exe`` in the ``src`` directory. -9. Enjoy using and testing the emulator! :) +9. 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 https://ci.86box.net, and the latest ROM set from https://github.com/86Box/roms. + +10. 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. From d56454faca9a1da7611b061dd5f43ea260d6fddf Mon Sep 17 00:00:00 2001 From: Daniel Gurney Date: Sun, 13 Jun 2021 17:57:54 +0300 Subject: [PATCH 6/6] Forgot some backticks --- dev/buildguide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev/buildguide.rst b/dev/buildguide.rst index bd8baad..e9693e4 100644 --- a/dev/buildguide.rst +++ b/dev/buildguide.rst @@ -32,7 +32,7 @@ In order to compile 86Box, please follow this step-by-step guide: 8. If the compilation succeeded (which it almost always should), you will find ``86Box.exe`` in the ``src`` directory. -9. 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 https://ci.86box.net, and the latest ROM set from https://github.com/86Box/roms. +9. 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 https://ci.86box.net, and the latest ROM set from https://github.com/86Box/roms. 10. Enjoy using and testing the emulator! :)