Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,24 @@
* [DOxygen](#optional-doxygen)

<a name="introduction"/>

## 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.

Source control is handled by github (***https://github.com/mamedev/mame.git***), so you'll need to check out a copy.
Various modules are disabled by default, but can be enabled through arguments when building and may require additional MSYS2 packages to be installed.

<a name="installandbuild"/>

## Installation and building

<a name="downloads"/>

### 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**)_

<a name="installation"/>

### 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**

Expand All @@ -48,6 +52,7 @@ git config --global user.name "Firstname Lastname"
```

<a name="building"/>

### Building
Then, to download the MAME source under your Msys2 user's homedir:
```sh
Expand All @@ -65,6 +70,7 @@ make
```

<a name="updating"/>

## Updating build tools

Similar to package managers on Linux like apt-get, yum etc. MSYS2 can automatically update packages for fixes, security updates etc.
Expand All @@ -82,15 +88,18 @@ pacman -Su --noconfirm
```

<a name="advanced"/>

## 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).

<a name="optional"/>

## Optional additional packages

<a name="optional-sdl"/>

### SDL
If you wish to build with the SDL renderer:

Expand All @@ -105,6 +114,7 @@ If you wish to build with the SDL renderer:
```

<a name="optional-qt5"/>

### QT5
If you wish to build with the QT5 debugger:

Expand All @@ -119,6 +129,7 @@ If you wish to build with the QT5 debugger:
```

<a name="optional-qt4"/>

### QT4
If you with to build the QMC2 frontend or similar:

Expand All @@ -133,6 +144,7 @@ If you with to build the QMC2 frontend or similar:
```

<a name="optional-doxygen"/>

### Doxygen
To be able to generate the documentation from the source:

Expand All @@ -141,6 +153,7 @@ To be able to generate the documentation from the source:
```

<a name="optional-ccache"/>

### CCache
To be able to use ccache to speed-up (re)compilation

Expand All @@ -154,6 +167,7 @@ To be able to use ccache to speed-up (re)compilation
pacman -S mingw-w64-i686-ccache
```
<a name="optional-ccache"/>

### CMake
Used as build system for some other project that can be handy

Expand All @@ -177,6 +191,7 @@ Used as build system for some other project that can be handy
```

<a name="optional-clang"/>

### Clang
If you wish to compile/link with the alternative Clang, go ahead and download:

Expand Down