summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatarGravatar Miodrag Milanovic <mmicko@gmail.com>2016-03-04 11:00:21 +0100
committerGravatarGravatar Miodrag Milanovic <mmicko@gmail.com>2016-03-04 11:00:21 +0100
commit5cef4e1f91010f0d573bbd662208979fa39e73ec (patch) (github)
tree80782033bdccf01b5d8eef57da23ac6d5cabda31 /README.md
parent8d4f4d62aaac3edef42d4544387ca45b5f0d9cd6 (diff)
downloadmame-5cef4e1f91010f0d573bbd662208979fa39e73ec.tar.bz2
mame-5cef4e1f91010f0d573bbd662208979fa39e73ec.zip
Added LICENSE file and updated README.md (nw)
Diffstat (limited to 'README.md')
-rw-r--r--README.md72
1 files changed, 48 insertions, 24 deletions
diff --git a/README.md b/README.md
index a83e4a627fe..c728ee0e8a6 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,19 @@
# **MAME** #
-[![Build Status](https://travis-ci.org/mamedev/mame.svg)](https://travis-ci.org/mamedev/mame) [![Build status](https://ci.appveyor.com/api/projects/status/te0qy56b72tp5kmo?svg=true)](https://ci.appveyor.com/project/startaq/mame) [![Join the chat at https://gitter.im/mamedev/mame](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mamedev/mame?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Join the chat at https://gitter.im/mamedev/mame](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mamedev/mame?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
What is MAME?
=============
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.
-
-
-License
-=======
-
-MAME is in the process of becoming a Free and Open Source project. We are still in the process of contacting all developers who have contributed in the past. We have received approval for the vast majority of contributions.
-
-Going forward, we will be using the 3-Clause BSD license for the core, and the LGPL version 2.1 or later, and the GPL version 2.0 or later, for certain drivers. As a whole, MAME will be delivered under the GPL version 2.0 or later.
-As we are still contacting developers, MAME is still distributed under the [MAME license](docs/mamelicense.txt) as of this time. If you have not been contacted yet, and believe you have contributed code to MAME in the past, please [contact us](mailto:mamedev@mamedev.org).
+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?). During time MAME absorbed his sister project MESS (Multi Emulator Super System), so MAME now documents a wide variety of (mostly vintage) computers, video game consoles, and calculators.
How to compile?
-=============
+===============
-If you're on a *nix system, it could be as easy as typing
+If you're on a *nix or OSX system, it could be as easy as typing
```
make
@@ -48,11 +31,23 @@ for an arcade-only build, or
make SUBTARGET=mess
```
-for a MESS build (provided you have all the [prerequisites](http://forums.bannister.org/ubbthreads.php?ubb=showflat&Number=35138)).
+for MESS build.
+
+For a Linux users we have provided you 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.
+For Windows users, we provide a ready-made [build environment](http://mamedev.org/tools/) based on MinGW-w64.
+Visual Studio builds are also possible, but you still need [build environment](http://mamedev.org/tools/) based on MinGW-w64.
+In order to generatesolution and project just run:
+```
+make vs2015
+```
+or use next to directly build it using msbuild
+
+```
+make vs2015 MSBUILD=1
+```
Where can I find out more?
@@ -72,5 +67,34 @@ MAME source code should be viewed and edited with your editor set to use four sp
Some parts of the code follow [GNU style](http://www.gnu.org/prep/standards/html_node/Formatting.html); some parts of the code follow [K&R style](https://en.wikipedia.org/wiki/Indent_style#K.26R_style) -- mostly depending on who wrote the original version. **Above all else, be consistent with what you modify, and keep whitespace changes to a minimum when modifying existing source.** For new code, the majority tends to prefer GNU style, so if you don't care much, use that.
-All contributors need to either add standard header for license info (on new files) or send us their wish under which of licenses they would like their code to be published under :[BSD-3-Clause](http://spdx.org/licenses/BSD-3-Clause), or for new files in mame/ or mess/, either the [BSD-3-Clause](http://spdx.org/licenses/BSD-3-Clause) license, the [LGPL-2.1+](http://spdx.org/licenses/LGPL-2.1+), or the [GPL-2.0+](http://spdx.org/licenses/GPL-2.0+).
+All contributors need to either add standard header for license info (on new files) or send us their wish under which of licenses they would like their code to be published under :[BSD-3-Clause](http://opensource.org/licenses/BSD-3-Clause) license, the [LGPL-2.1](http://opensource.org/licenses/LGPL-2.1), or the [GPL-2.0](http://opensource.org/licenses/GPL-2.0).
+
+License
+=======
+MAME project as a whole is licnesed under [GPL-2.0](http://opensource.org/licenses/GPL-2.0) license, since it contains code that is under multiple licenses. Great majority of files (over 90%) (including core files) are under [BSD-3-Clause](http://opensource.org/licenses/BSD-3-Clause) and we would encourage new developers to distribute files under this license.
+
+[License (GPL-2.0)](LICENSE)
+============================
+
+<a href="http://opensource.org/licenses/GPL-2.0" target="_blank">
+<img align="right" src="http://opensource.org/trademarks/opensource/OSI-Approved-License-100x137.png">
+</a>
+
+<pre>
+MAME - Multiple Arcade Machine Emulator
+Copyright (C) 1997-2016 Nicola Salmoria and the MAME team
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+</pre>