Skip to content

Commit 87a8943

Browse files
committed
Update readme for various changes in tools package contents
1 parent 600507f commit 87a8943

File tree

1 file changed

+50
-44
lines changed

1 file changed

+50
-44
lines changed

README.md

Lines changed: 50 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
11
# MAME Build Tools
22

3-
##### Table of Contents
3+
##### Table of Contents
44
* [Introduction](#introduction)
5-
* [Installation and building](#installandbuild)
6-
* [Downloads](#downloads)
7-
* [Installation](#installation)
8-
* [Building](#building)
9-
* [Updating build tools](#updating)
5+
* [Installation and building](#installandbuild)
6+
* [Downloads](#downloads)
7+
* [Installation](#installation)
8+
* [Building](#building)
9+
* [Updating build tools](#updating)
1010
* [Alternative Shells for advanced usage](#advanced)
11-
* [Optional additional packages](#optional)
12-
* [SDL](#optional-sdl)
13-
* [QT5](#optional-qt5)
14-
* [QT4](#optional-qt4)
15-
* [CCache](#optional-ccache)
16-
* [CMake](#optional-cmake)
17-
* [DOxygen](#optional-doxygen)
11+
* [Optional additional packages](#optional)
12+
* [32-bit tools](#optional-32bit)
13+
* [GNU Debugger (gdb)](#optional-gdb)
14+
* [QT5](#optional-qt5)
15+
* [QT4](#optional-qt4)
16+
* [CCache](#optional-ccache)
17+
* [CMake](#optional-cmake)
18+
* [Clang](#optional-clang)
1819

1920
<a name="introduction"/>
2021

2122
## Introduction
22-
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.
23+
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.
2324

2425
Source control is handled by github (***https://github.com/mamedev/mame.git***), so you'll need to check out a copy.
2526
Various modules are disabled by default, but can be enabled through arguments when building and may require additional MSYS2 packages to be installed.
@@ -31,14 +32,14 @@ Various modules are disabled by default, but can be enabled through arguments wh
3132
<a name="downloads"/>
3233

3334
### Downloads
34-
* 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**)_
35+
* 64-bit - [msys64-2021-01-12.exe](https://github.com/mamedev/buildtools/releases/download/7.0/msys64-2021-01-12.exe) _(Only 64-bit tools and libraries are included. To build 32-bit binaries, install the 32-bit MinGW tools, and switch between environments using **config32.bat** and **config64.bat**)_
3536

3637
<a name="installation"/>
3738

3839
### Installation
39-
If you are installing it in a location other than the default (*c:\msys64* or *c:\msys32*), after you unpack double-click : **autorebase.bat**
40+
If you are installing it in a location other than the default (*C:\Users\Public\msys64*), after you unpack double-click : **autorebase.bat**
4041

41-
To open a non-posix shell there are two batch files: **win32env.bat** for regular Windows console.
42+
To open a non-POSIX shell there is a batch file: **win32env.bat** for regular Windows console.
4243

4344
**Important** thing is to setup your git environment first
4445
```sh
@@ -90,27 +91,41 @@ pacman -Su --noconfirm
9091
<a name="advanced"/>
9192

9293
## Alternative Shells for advanced usage
93-
For a simple MSYS32 terminal use **mingw64.exe** to start or **mingw32.exe** .
94+
For a simple MSYS32 terminal use **mingw64.exe** to start or (or **mingw32.exe** for a 32-bit environment).
9495

95-
For more information about Msys2, see [MSYS2 Introduction](https://github.com/msys2/msys2/wiki/MSYS2-introduction).
96+
For more information about MSYS2, see [MSYS2 Introduction](https://github.com/msys2/msys2/wiki/MSYS2-introduction).
9697

9798
<a name="optional"/>
9899

99100
## Optional additional packages
100101

101-
<a name="optional-sdl"/>
102102

103-
### SDL
104-
If you wish to build with the SDL renderer:
103+
<a name="optional-32bit"/>
105104

106-
**For x64**
105+
### 32-bit tools
106+
If you wish to build 32-bit binaries:
107107
```sh
108-
pacman -S mingw-w64-x86_64-SDL2 mingw-w64-x86_64-SDL2_ttf
108+
pacman -S mingw-w64-i686-gcc mingw-w64-i686-libc++ mingw-w64-i686-lld mingw-w64-i686-python mingw-w64-i686-SDL2 mingw-w64-i686-SDL2_ttf
109109
```
110110

111-
**For x86**
111+
<a name="optional-gdb"/>
112+
113+
### GNU Debugger (gdb)
114+
If you wish to debug with gdb:
115+
116+
**For MSYS2 x64**
117+
```sh
118+
pacman -S gdb
119+
```
120+
121+
**For MinGW x64**
122+
```sh
123+
pacman -S mingw-w64-x86_64-gdb
124+
```
125+
126+
**For MinGW x86**
112127
```sh
113-
pacman -S mingw-w64-i686-SDL2 mingw-w64-i686-SDL2_ttf
128+
pacman -S mingw-w64-i686-gdb
114129
```
115130

116131
<a name="optional-qt5"/>
@@ -143,42 +158,34 @@ If you with to build the QMC2 frontend or similar:
143158
pacman -S mingw-w64-i686-qt4
144159
```
145160

146-
<a name="optional-doxygen"/>
147-
148-
### Doxygen
149-
To be able to generate the documentation from the source:
150-
151-
```sh
152-
pacman -S doxygen
153-
```
154-
155161
<a name="optional-ccache"/>
156162

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

160166
**For x64**
161167
```sh
162-
pacman -S mingw-w64-x86_64-ccache
168+
pacman -S mingw-w64-x86_64-ccache
163169
```
164170

165171
**For x86**
166172
```sh
167-
pacman -S mingw-w64-i686-ccache
173+
pacman -S mingw-w64-i686-ccache
168174
```
169-
<a name="optional-ccache"/>
175+
176+
<a name="optional-cmake"/>
170177

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

174181
**For x64**
175182
```sh
176-
pacman -S mingw-w64-x86_64-cmake
183+
pacman -S mingw-w64-x86_64-cmake
177184
```
178185

179186
**For x86**
180187
```sh
181-
pacman -S mingw-w64-i686-cmake
188+
pacman -S mingw-w64-i686-cmake
182189
```
183190

184191
**To build in Windows environment use from build folder:**
@@ -189,19 +196,18 @@ Used as build system for some other project that can be handy
189196
```sh
190197
cmake -G "MSYS Makefiles" ..
191198
```
192-
199+
193200
<a name="optional-clang"/>
194201

195202
### Clang
196203
If you wish to compile/link with the alternative Clang, go ahead and download:
197-
204+
198205
**For x64**
199206
```sh
200-
pacman -S mingw-w64-x86_64-clang mingw-w64-x86_64-clang-analyzer mingw-w64-x86_64-clang-tools-extra
207+
pacman -S mingw-w64-x86_64-clang mingw-w64-x86_64-clang-analyzer mingw-w64-x86_64-clang-tools-extra
201208
```
202209

203210
**For x86**
204211
```sh
205212
pacman -S mingw-w64-i686-clang mingw-w64-i686-clang-analyzer mingw-w64-i686-clang-tools-extra
206213
```
207-

0 commit comments

Comments
 (0)