summaryrefslogtreecommitdiffstats
path: root/docs/release/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/release/README.md')
-rw-r--r--docs/release/README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/release/README.md b/docs/release/README.md
new file mode 100644
index 00000000000..0f2924803ac
--- /dev/null
+++ b/docs/release/README.md
@@ -0,0 +1,42 @@
+What is HBMAME?
+===============
+
+HBMAME stands for Home Brew MAME. It runs on Windows 7 or later.
+
+HBMAME has 2 purposes:
+Firstly is to preserve homebrew games written for arcade machines or arcade emulators.
+Secondly is to include worthwhile hacks of arcade games.
+All the documentation of the hardware can be found in the MAME source.
+
+How to compile
+==============
+
+```
+make TARGET=hbmame
+```
+
+or
+
+```
+make TARGET=hbmame OSD=winui
+```
+
+For HBMAMEUI, you must use GCC 10.1 - later versions will compile but crash at start.
+
+
+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 HBMAME site](http://hbmame.1emulation.com/)
+* [Forum](http://www.mameworld.info/ubbthreads/postlist.php?Cat=&Board=misfitmame) (bug reports go here too)
+
+
+Licensing Information
+=====================
+
+Information about the MAME content can be found at https://github.com/mamedev/mame/blob/master/README.md
+
+Information about the MAME license can be found at https://github.com/mamedev/mame/blob/master/COPYING
+
+Information about the WINUI portion can be found at https://github.com/Robbbert/mameui/blob/master/docs/winui_license.txt