diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 65 |
1 files changed, 25 insertions, 40 deletions
diff --git a/README.md b/README.md index 11e1a799e2a..636bde36d3a 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,31 @@ +# MAME -# **MAME** # +## What is MAME? -[](https://gitter.im/mamedev/mame?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +MAME is a multi-purpose emulation framework. -Continuous integration build status: +MAME's purpose is to preserve decades of software history. As electronic technology continues to rush forward, MAME prevents this important "vintage" software 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 software is usable serves primarily to validate the accuracy of the documentation (how else can you prove that you have recreated the hardware faithfully?). Over time, MAME (originally stood for Multiple Arcade Machine Emulator) absorbed the sister-project MESS (Multi Emulator Super System), so MAME now documents a wide variety of (mostly vintage) computers, video game consoles and calculators, in addition to the arcade video games that were its initial focus. -| OS/Compiler | Status | -| --------------------------- |:-------------:| -| Linux/clang and GCC | /badge.svg) | -| Windows/MinGW GCC and clang | /badge.svg) | -| macOS/clang | /badge.svg) | -| UI Translations |  | -| Documentation |  | -| BGFX Shaders |  | +## Where can I find out more? -Static analysis status for entire build (except for third-party parts of project): +* [Official MAME Development Team Site](https://www.mamedev.org/) (includes binary downloads, wiki, forums, and more) +* [MAME Testers](https://mametesters.org/) (official bug tracker for MAME) -[](https://scan.coverity.com/projects/mame-emulator) +### Community -What is MAME? -============= +* [MAME Forums on bannister.org](https://forums.bannister.org/ubbthreads.php?ubb=cfrm&c=5) +* [r/MAME](https://www.reddit.com/r/MAME/) on Reddit +* [MAMEWorld Forums](https://www.mameworld.info/ubbthreads/) -MAME is a multi-purpose emulation framework. +## Development -MAME's purpose is to preserve decades of software history. As electronic technology continues to rush forward, MAME prevents this important "vintage" software 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 software is usable serves primarily to validate the accuracy of the documentation (how else can you prove that you have recreated the hardware faithfully?). Over time, MAME (originally stood for Multiple Arcade Machine Emulator) absorbed the sister-project MESS (Multi Emulator Super System), so MAME now documents a wide variety of (mostly vintage) computers, video game consoles and calculators, in addition to the arcade video games that were its initial focus. + + +### CI status and code scanning + +[/badge.svg)](https://github.com/mamedev/mame/actions/workflows/ci-linux.yml) [/badge.svg)](https://github.com/mamedev/mame/actions/workflows/ci-windows.yml) [/badge.svg)](https://github.com/mamedev/mame/actions/workflows/ci-macos.yml) [](https://github.com/mamedev/mame/actions/workflows/language.yml) [](https://github.com/mamedev/mame/actions/workflows/docs.yml) [](https://scan.coverity.com/projects/mame-emulator) -How to compile? -=============== +### How to compile? If you're on a UNIX-like system (including Linux and macOS), it could be as easy as typing @@ -52,27 +51,15 @@ Visual Studio builds are also possible, but you still need [build environment](h In order to generate solution and project files just run: ``` -make vs2019 +make vs2022 ``` or use this command to build it directly using msbuild ``` -make vs2019 MSBUILD=1 +make vs2022 MSBUILD=1 ``` - -Where can I find out more? -============= - -* [Official MAME Development Team Site](https://www.mamedev.org/) (includes binary downloads, wiki, forums, and more) -* [Official MESS Wiki](http://mess.redump.net/) -* [MAME Testers](https://mametesters.org/) (official bug tracker for MAME and MESS) - - -Contributing -============= - -## Coding standard +### Coding standard MAME source code should be viewed and edited with your editor set to use four spaces per tab. Tabs are used for initial indentation of lines, with one tab used per indentation level. Spaces are used for other alignment within a line. @@ -82,9 +69,7 @@ All contributors need to either add a standard header for license info (on new f See more specific [C++ Coding Guidelines](https://docs.mamedev.org/contributing/cxx.html) on our documentation web site. - -License -======= +## License The MAME project as a whole is made available under the terms of the [GNU General Public License, version 2](http://opensource.org/licenses/GPL-2.0) @@ -99,10 +84,10 @@ Please note that MAME is a registered trademark of Gregory Ember, and permission is required to use the "MAME" name, logo, or wordmark. <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"> +<img align="right" width="100" src="https://opensource.org/wp-content/uploads/2009/06/OSIApproved.svg"> </a> - Copyright (C) 1997-2021 MAMEDev and contributors + Copyright (c) 1997-2025 MAMEdev and contributors This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2, as provided in @@ -113,4 +98,4 @@ is required to use the "MAME" name, logo, or wordmark. FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. -Please see COPYING for more details. +Please see [COPYING](COPYING) for more details. |