From 3a6d2f3e69fa2fde43a4cca558d177ac17524900 Mon Sep 17 00:00:00 2001 From: couriersud Date: Tue, 28 Jan 2020 20:54:36 +0100 Subject: [PATCH] Fix display of hedings in README.md (nw) --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index dce2697..37b5a82 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ * [DOxygen](#optional-doxygen) + ## Introduction The MAME development environment for Windows consists of the GCC compiler (by way of MinGW), and the MSYS2 (POSIX/Unix compatability layer), plus various utilities such as Python and Git. It is available as a prepackaged installer, or can be assembled from upstream components. @@ -24,13 +25,16 @@ Source control is handled by github (***https://github.com/mamedev/mame.git***), Various modules are disabled by default, but can be enabled through arguments when building and may require additional MSYS2 packages to be installed. + ## Installation and building + ### Downloads * Dual 32-bit/64-bit - [msys64-32-2019-12-23.exe](https://github.com/mamedev/buildtools/releases/download/5.0/msys64-32-2019-12-23.exe) _(If you have 64-bit Windows but wish to build for both 32-bit and 64-bit. To switch between different mingw versions use **config32.bat** and **config64.bat**)_ + ### Installation If you are installing it in a location other than the default (*c:\msys64* or *c:\msys32*), after you unpack double-click : **autorebase.bat** @@ -48,6 +52,7 @@ git config --global user.name "Firstname Lastname" ``` + ### Building Then, to download the MAME source under your Msys2 user's homedir: ```sh @@ -65,6 +70,7 @@ make ``` + ## Updating build tools Similar to package managers on Linux like apt-get, yum etc. MSYS2 can automatically update packages for fixes, security updates etc. @@ -82,15 +88,18 @@ pacman -Su --noconfirm ``` + ## Alternative Shells for advanced usage For a simple MSYS32 terminal use **mingw64.exe** to start or **mingw32.exe** . For more information about Msys2, see [MSYS2 Introduction](https://github.com/msys2/msys2/wiki/MSYS2-introduction). + ## Optional additional packages + ### SDL If you wish to build with the SDL renderer: @@ -105,6 +114,7 @@ If you wish to build with the SDL renderer: ``` + ### QT5 If you wish to build with the QT5 debugger: @@ -119,6 +129,7 @@ If you wish to build with the QT5 debugger: ``` + ### QT4 If you with to build the QMC2 frontend or similar: @@ -133,6 +144,7 @@ If you with to build the QMC2 frontend or similar: ``` + ### Doxygen To be able to generate the documentation from the source: @@ -141,6 +153,7 @@ To be able to generate the documentation from the source: ``` + ### CCache To be able to use ccache to speed-up (re)compilation @@ -154,6 +167,7 @@ To be able to use ccache to speed-up (re)compilation pacman -S mingw-w64-i686-ccache ``` + ### CMake Used as build system for some other project that can be handy @@ -177,6 +191,7 @@ Used as build system for some other project that can be handy ``` + ### Clang If you wish to compile/link with the alternative Clang, go ahead and download: