diff options
author | kcgen <1557255+kcgen@users.noreply.github.com> | 2021-08-26 06:37:26 +0300 |
---|---|---|
committer | kcgen <1557255+kcgen@users.noreply.github.com> | 2021-08-26 07:01:28 +0300 |
commit | e9bb9a6df50020ea9ec0b01044dd79bd34812748 (patch) | |
tree | 754f0aea6286783cd6db410abb8e58c8b2b556ec /README.md | |
parent | 0507817ac54b6f027c9ff9c257ffa685d8009adf (diff) |
Add notes about cloning with submodules
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 19 |
1 files changed, 17 insertions, 2 deletions
@@ -82,7 +82,7 @@ Feature differences between release binaries (or unpatched sources): | **Relative window size** | Yes (`windowresolution=small`, `medium`, or `large`) | `windowresolution=X%` | **[OPL] emulators** | compat, fast, mame, nuked<sup>[8]</sup> | compat, fast, mame | **[CGA]/mono support** | Yes (`machine=cga_mono`)<sup>[9]</sup> | Only CGA with colour -| **PCjr CGA composite mode** | Yes (`machine=pcjr` with composite hotkeys) | N/A +| **CGA composite modes** | Yes (`machine=pcjr/tandy/cga` with hotkeys) | N/A | **[Wayland] support** | Experimental (use `SDL_VIDEODRIVER=wayland`) | N/A | **Modem phonebook file** | Yes (`phonebookfile=<name>`) | N/A | **Autotype command** | Yes<sup>[10]</sup> | N/A @@ -117,6 +117,21 @@ Feature differences between release binaries (or unpatched sources): [Links to the newest builds](https://dosbox-staging.github.io/downloads/devel/) +## Get the source + +New users can clone the repository and submodules with: + +``` shell +git clone --recurse-submodules \ + https://github.com/dosbox-staging/dosbox-staging.git +``` + +If you have an existing source repository, update it with: + +``` shell +git pull --recurse-submodules +``` + ## Build instructions Read [BUILD.md] for the comprehensive compilation guide. @@ -167,7 +182,7 @@ brew install ccache meson libpng sdl2 sdl2_net opusfile fluid-synth Instructions for creating an optimised release build: ``` shell -git clone https://github.com/dosbox-staging/dosbox-staging.git +git clone --recurse-submodules https://github.com/dosbox-staging/dosbox-staging.git cd dosbox-staging meson setup -Dbuildtype=release build ninja -C build |