Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/dosbox-staging/dosbox-staging.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPatryk Obara <dreamer.tan@gmail.com>2021-02-18 16:13:40 +0300
committerPatryk Obara <patryk.obara@gmail.com>2021-02-19 21:36:58 +0300
commit1965ada7b3de2b2440387ee5a4b0dc8c47acbe89 (patch)
treeae2e00250e2a70b2ec4f156f6a9ac633ec117d83 /docs
parentcbd106d5fe69578e7d48ae24f2ac6207a91fca76 (diff)
Move macOS-specific instructions to separate file
Diffstat (limited to 'docs')
-rw-r--r--docs/build-macos.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/build-macos.md b/docs/build-macos.md
new file mode 100644
index 000000000..dfb2fa151
--- /dev/null
+++ b/docs/build-macos.md
@@ -0,0 +1,50 @@
+macOS builds can be created using the Meson buildsystem, compiled using
+the Clang or GCC compilers, and provided with dependencies using the Homebrew
+or MacPorts package managers.
+
+We're recommending using Homebrew and Clang, because Apple's Core SDKs can be
+used only with Apple's fork of Clang compiler.
+
+## Install Dependencies under macOS
+
+Before installing either Homebrew or MacPorts, the Apple's Xcode tools need
+to be installed and the license agreed to:
+
+## Xcode Installation
+
+1. Install the command line tools: `xcode-select --install`
+2. Accept the license agreement: `sudo xcodebuild -license`
+3. Install build dependencies using either Homebrew or MacPorts.
+
+### Install dependencies (Homebrew)
+
+1. Install Homebrew: <https://brew.sh>.
+2. Install dependencies:
+
+ ``` shell
+ brew install ccache meson libpng sdl2 sdl2_net opusfile fluid-synth
+ ```
+
+### Install dependencies (MacPorts)
+
+1. Install MacPorts: <https://www.macports.org/install.php>
+2. Install depedencies:
+
+ ``` shell
+ sudo port -q install meson ccache libpng libsdl2 libsdl2_net \
+ opusfile fluidsynth
+ ```
+
+## Build
+
+Once you have depenendcies installed using either environment, clone and
+enter the repository's directory:
+
+``` shell
+git clone https://github.com/dosbox-staging/dosbox-staging.git
+cd dosbox-staging
+meson setup build
+ninja -C build
+```
+
+Detailed instructions and build options are documented in [BUILD.md](/BUILD.md).