Add a documentation folder
This commit is contained in:
24
README.md
24
README.md
@@ -28,29 +28,7 @@ See [this](https://86box.github.io/gettingstarted) page on our website for a qui
|
|||||||
|
|
||||||
Building
|
Building
|
||||||
--------
|
--------
|
||||||
In order to compile 86Box from this repository, please follow this step-by-step
|
See the [build guide](doc/build.md).
|
||||||
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 with `<MSYS2 root>\mingw32.exe`.
|
|
||||||
3. Once launched, run `pacman -Syu` in order to update the environment. You may need to do this twice, just follow the on-screen instructions. Make sure you re-run `pacman -Syu` 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`. Additionally, you will need to download the developer's pack of WinPcap [from here](https://www.winpcap.org/devel.htm), and extract it into `<MSYS2 root>\mingw32\`.
|
|
||||||
5. Once the environment is fully updated and all dependencies are installed, `cd` into your cloned `86box\src`
|
|
||||||
directory.
|
|
||||||
6. Run `make -jN -f win/makefile.mingw` to start the actual compilation process.
|
|
||||||
Substitute `N` with the number of threads you want to use for the compilation
|
|
||||||
process. The optimal number depends entirely on your processor, and it is
|
|
||||||
up to you to determine it. A good starting point is the total
|
|
||||||
number of threads (AKA Logical Processors) you have available.
|
|
||||||
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.
|
|
||||||
|
|
||||||
Automatic builds
|
Automatic builds
|
||||||
--------------
|
--------------
|
||||||
|
1
doc/README
Normal file
1
doc/README
Normal file
@@ -0,0 +1 @@
|
|||||||
|
This directory contains 86Box documentation.
|
38
doc/build.md
Normal file
38
doc/build.md
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
Building
|
||||||
|
========
|
||||||
|
In order to compile 86Box from this repository, 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, switch into the `src` directory of the 86Box source:
|
||||||
|
```console
|
||||||
|
$ cd path/to/86Box/src
|
||||||
|
```
|
||||||
|
|
||||||
|
6. Start the actual compilation process:
|
||||||
|
```console
|
||||||
|
$ make -f win/Makefile.mingw
|
||||||
|
```
|
||||||
|
By default, `make` does not run parallely. If you want it to use more threads, use the `-j` with the number of threads you want to use for the compilation process, i.e. `-j4`.
|
||||||
|
|
||||||
|
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.
|
Reference in New Issue
Block a user