Update README.source-code-description

This commit is contained in:
Wengier
2020-06-29 00:05:45 -04:00
committed by GitHub
parent 59226918b6
commit 2a6ac86f79

View File

@@ -18,7 +18,7 @@ The four major operating systems and platforms of DOSBox-X are (in this order):
3. Linux (with X11) on a Raspberry Pi 3 (arm 7). 3. Linux (with X11) on a Raspberry Pi 3 (arm 7).
4. Mac OS X (macOS) Sierra 10.12 or higher 64-bit. 4. macOS (Mac OS X) Sierra 10.12 or higher 64-bit.
Straight Windows builds are expected to compile using the free community edition Straight Windows builds are expected to compile using the free community edition
of Visual Studio 2015 to Visual Studio 2019 and the DirectX 2010 SDK. of Visual Studio 2015 to Visual Studio 2019 and the DirectX 2010 SDK.
@@ -26,7 +26,7 @@ of Visual Studio 2015 to Visual Studio 2019 and the DirectX 2010 SDK.
Linux and MinGW Windows builds are expected to compile with the GNU autotools. Linux and MinGW Windows builds are expected to compile with the GNU autotools.
A preliminary CMake build system is available, see README.cmake.md for details. A preliminary CMake build system is available, see README.cmake.md for details.
Mac OS X (macOS) builds are expected to compile on the terminal using GNU macOS (Mac OS X) builds are expected to compile on the terminal using GNU
autotools and the LLVM/Clang compiler provided by XCode. autotools and the LLVM/Clang compiler provided by XCode.
In all cases, the code requires a C++ compiler that can support the C++11 In all cases, the code requires a C++ compiler that can support the C++11
@@ -50,7 +50,7 @@ In Windows, the modifications also permit the emulation to run independent
of the main window so that moving, resizing, or using menus does not cause of the main window so that moving, resizing, or using menus does not cause
emulation to pause. emulation to pause.
In Mac OS X (macOS), the modifications provide an interface to allow DOSBox-X In macOS (Mac OS X), the modifications provide an interface to allow DOSBox-X
to replace and manage the macOS menu bar. to replace and manage the macOS menu bar.
How to compile the source code (cross-platform) How to compile the source code (cross-platform)
@@ -64,10 +64,10 @@ General Linux compile (SDL2)
./build-debug-sdl2 ./build-debug-sdl2
sudo make install sudo make install
Mac OS X (macOS) compile macOS (Mac OS X) compile
./build-macosx ./build-macosx
Mac OS X (macOS) compile (SDL2) macOS (Mac OS X) compile (SDL2)
./build-macosx-sdl2 ./build-macosx-sdl2
MinGW compile (on Windows, using MinGW64) for 32-bit Windows XP MinGW compile (on Windows, using MinGW64) for 32-bit Windows XP
@@ -82,10 +82,10 @@ MinGW compile (on Windows, using MinGW, not MinGW64) to target MS-DOS and the HX
NOTICE: Use the 32-bit toolchain from the main MinGW project, not the MinGW64 project. NOTICE: Use the 32-bit toolchain from the main MinGW project, not the MinGW64 project.
Binaries compiled with MinGW64 have extra dependencies not provided by the HX DOS Extender. Binaries compiled with MinGW64 have extra dependencies not provided by the HX DOS Extender.
Mac OS X (macOS): If you want to make an .app bundle you can run from the Finder, compile the macOS (Mac OS X): If you want to make an .app bundle you can run from the Finder, compile the
program as instructed then run "make dosbox-x.app". program as instructed then run "make dosbox-x.app".
XCode (on Mac OS X, from the Terminal) to target Mac OS X (macOS) XCode (on macOS, from the Terminal) to target macOS
./build-debug ./build-debug
To compile DOSBox-X in Ubuntu (added by kapper1224): To compile DOSBox-X in Ubuntu (added by kapper1224):
@@ -198,7 +198,7 @@ src/gui/menu.cpp Menu handling and management, processing,
and not HX DOS and not SDL2 and not HX DOS and not SDL2
Mac OS X (NSMENU) is used if targeting Apple Mac OS X (NSMENU) is used if targeting Apple
Mac OS X and not SDL2 macOS and not SDL2
SDL drawn menus are used in all other cases. SDL drawn menus are used in all other cases.
@@ -222,7 +222,7 @@ src/gui/render_scalers.cpp Render scaler definitions and code. Note that
src/gui/midi.cpp MIDI output framework. Header files include src/gui/midi.cpp MIDI output framework. Header files include
additional platform-specific code. additional platform-specific code.
src/gui/menu_osx.mm Mac OS X Objective C++ code to bridge Objective C src/gui/menu_osx.mm macOS Objective C++ code to bridge Objective C
and C++ so that the menu manipulation code can and C++ so that the menu manipulation code can
work correctly. work correctly.