Miroirs/mame
1
0
Fork 0
mirror of https://github.com/mamedev/mame.git synced 2024-11-16 07:48:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
mame/docs/source/index.rst

42 lines
899 B
ReStructuredText
Raw Normal View History

Added documentation to main tree (nw)
2016-08-24 15:15:09 +02:00
.. MAME documentation master file, created by
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
(nw) Clean up the mess on master This effectively reverts b380514764cf857469bae61c11143a19f79a74c5 and c24473ddff715ecec2e258a6eb38960cf8c8e98e, restoring the state at 598cd5227223c3b04ca31f0dbc1981256d9ea3ff. Before pushing, please check that what you're about to push is sane. Check your local commit log and ensure there isn't anything out-of-place before pushing to mainline. When things like this happen, it wastes everyone's time. I really don't need this in a week when real work™ is busting my balls and I'm behind where I want to be with preparing for MAME release.
2019-03-26 01:13:37 +01:00
.. image:: images/MAMElogo.svg
:width: 100%
:align: center
:alt: MAME
Added documentation to main tree (nw)
2016-08-24 15:15:09 +02:00
MAME Documentation
==================
.. note::
Miscellaneous change roll-up: render/drawbgfx.cpp: Return an error if Wayland EGL surface can't be created for additional windows. emu/emucore.h: Added explicitly defaulted copy and move constructors for emu_fatalerror. Fixed apparent misunderstanding of const. Returning const value types and casting to const value types is pointless outside very narrow use cases. Putting const value type parameters in interfaces just makes trouble. cpu/adsp2100: Use count_leading_ones_32 where it's simple rather than inverting and counting leading zeroes. util/multibyte.h: Don't pollute global namespace, constexpr implies inline, make narrowing casts explicit. imagedev/simh_tape_image.h: inline is implied for member functions with bodies supplied at declaration. Tidied up some ugly casts in various places.
2023-09-28 17:56:51 +02:00
This documentation is a work in progress. You can track the status of these topics through MAME's `issue tracker <https://github.com/mamedev/mame/issues>`_. Learn how you can :ref:`contribute <contributing>`.
(nw) Clean up the mess on master This effectively reverts b380514764cf857469bae61c11143a19f79a74c5 and c24473ddff715ecec2e258a6eb38960cf8c8e98e, restoring the state at 598cd5227223c3b04ca31f0dbc1981256d9ea3ff. Before pushing, please check that what you're about to push is sane. Check your local commit log and ensure there isn't anything out-of-place before pushing to mainline. When things like this happen, it wastes everyone's time. I really don't need this in a week when real work™ is busting my balls and I'm behind where I want to be with preparing for MAME release.
2019-03-26 01:13:37 +01:00
Added documentation to main tree (nw)
2016-08-24 15:15:09 +02:00
.. toctree::
:titlesonly:
allow repeating elements and groups - useful if you need e.g. a lot of numbered labels, but it limits complay.py's ability to check for invalid references as it can't evaluate expressions (nw)
2018-07-22 01:52:50 +02:00
Added documentation to main tree (nw)
2016-08-24 15:15:09 +02:00
whatis
Documentation updates (#6825) Documentation updates [Firehawke] * Preliminary work on -joystick_map redesign * Adjustments to phrasing for analog mapping * Health warning text
2020-07-18 14:15:13 +02:00
healthwarning
Added documentation to main tree (nw)
2016-08-24 15:15:09 +02:00
initialsetup/index
usingmame/index
commandline/index
-docs: Started documenting plugins. * Also added a couple of missing command-line options, and added a local table of contents to the (rather long) command line options page. -Added a separate CI target for localisation updates that produces an artefact, and removed the message catalogs from the trigger paths for the Linux CI build.
2021-10-23 20:48:05 +02:00
plugins/index
Added documentation to main tree (nw)
2016-08-24 15:15:09 +02:00
advanced/index
First pass of MAME Debugger help for documentation. (NW)
2018-01-14 05:56:18 +01:00
debugger/index
docs: Moved Lua API reference to its own section - the page was far too long.
2023-07-06 01:52:10 +02:00
luascript/index
Added documentation to main tree (nw)
2016-08-24 15:15:09 +02:00
tools/index
docs: Added preliminary guide for would-be contributors. (#10717) [Ryan Holtz, Vas Crabb, O. Galibert]
2022-12-21 21:17:55 +01:00
contributing/index
Added documentation to main tree (nw)
2016-08-24 15:15:09 +02:00
techspecs/index
security
license
(nw) Clean up the mess on master This effectively reverts b380514764cf857469bae61c11143a19f79a74c5 and c24473ddff715ecec2e258a6eb38960cf8c8e98e, restoring the state at 598cd5227223c3b04ca31f0dbc1981256d9ea3ff. Before pushing, please check that what you're about to push is sane. Check your local commit log and ensure there isn't anything out-of-place before pushing to mainline. When things like this happen, it wastes everyone's time. I really don't need this in a week when real work™ is busting my balls and I'm behind where I want to be with preparing for MAME release.
2019-03-26 01:13:37 +01:00
Added documentation to main tree (nw)
2016-08-24 15:15:09 +02:00
Contribute
----------
The documentation on this site is the handiwork of our many contributors.
Reference in a new issue Copy permalink