diff --git a/dev/buildguide.rst b/dev/buildguide.rst index 7f05d9f..5f0266f 100644 --- a/dev/buildguide.rst +++ b/dev/buildguide.rst @@ -1,17 +1,17 @@ Build guide =========== -In order to compile 86Box, please follow these steps: +Follow these steps to compile 86Box from source: -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. +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. +2. Launch your MSYS2 environment using the `MSYS2 MinGW 32-bit` shortcut. If you do not wish to use the shortcut, launch it using the `mingw32.exe` executable in the MSYS2 root. 3. Once launched, you should update the environment: .. 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. + You may need to do this twice, just follow the on-screen instructions. Please re-run the command periodically to keep the environment up-to-date. 4. Run the following command to install all of the dependencies: .. code-block:: bash @@ -28,13 +28,12 @@ In order to compile 86Box, please follow these steps: $ 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. + ``make`` does not run in parallel by default. Use the ``-j`` switch to specify the number of parallel threads, such as ``-j4`` for 4 threads. You should not exceed your system's thread (logical processor) count, as that uses more resources for little to no gain. -8. If the compilation succeeded (which it almost always should), you will find ``86Box.exe`` in the ``src`` directory. +8. If compilation succeeded (which it almost always should), the ``86Box.exe`` executable will be 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 the `86Box Jenkins `_, and the latest ROM set from `the roms repository `_. 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. +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.