summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatarGravatar Justin Kerk <dopefishjustin@gmail.com>2014-11-30 12:45:31 -0800
committerGravatarGravatar Justin Kerk <dopefishjustin@gmail.com>2014-11-30 12:45:31 -0800
commit8e8f3a656436416474ae480e9e6597c74bd09c66 (patch) (github)
tree31c153a521aac8ad7faf64ffcc7a0d81372f3338
parentd3c776510f8f8bd3a10b5523b4e9f5408cbc321f (diff)
downloadmame-8e8f3a656436416474ae480e9e6597c74bd09c66.tar.bz2
mame-8e8f3a656436416474ae480e9e6597c74bd09c66.zip
Add more info to the GitHub readme to prevent confusion. [Justin Kerk]
-rw-r--r--README.md31
1 files changed, 30 insertions, 1 deletions
diff --git a/README.md b/README.md
index a6e12a6353a..fc78ba7793a 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,35 @@
What is MAME?
=============
-MAME stands for Multiple Arcade Machine Emulator.
+MAME stands for Multiple Arcade Machine Emulator.
MAME's purpose is to preserve decades of video-game history. As gaming technology continues to rush forward, MAME prevents these important "vintage" games from being lost and forgotten. This is achieved by documenting the hardware and how it functions. The source code to MAME serves as this documentation. The fact that the games are playable serves primarily to validate the accuracy of the documentation (how else can you prove that you have recreated the hardware faithfully?).
+
+What is MESS?
+=============
+
+MESS (Multi Emulator Super System) is the sister project of MAME. MESS documents the hardware for a wide variety of (mostly vintage) computers, video game consoles, and calculators, as MAME does for arcade games.
+
+The MESS and MAME projects live in the same source repository and share much of the same code, but are different build targets.
+
+How to compile?
+=============
+
+If you're on a *nix system, it could be as easy as typing
+
+```make```
+
+for a MAME build, or
+
+```make TARGET=mess```
+
+for a MESS build (provided you have all the [prerequisites](http://forums.bannister.org/ubbthreads.php?ubb=showflat&Number=35138)).
+
+For Windows users, we provide a ready-made [build environment](http://mamedev.org/tools/) based on MinGW-w64. [Visual Studio builds](http://wiki.mamedev.org/index.php?title=Building_MAME_using_Microsoft_Visual_Studio_compilers) are also possible.
+
+Where can I find out more?
+=============
+
+* [Official MAME Development Team Site](http://mamedev.org/) (includes binary downloads for MAME and MESS, wiki, forums, and more)
+* [Official MESS Wiki](http://www.mess.org/)
+* [MAME Testers](http://mametesters.org/) (official bug tracker for MAME and MESS)