Convert readme to markdown (#5)

This commit is contained in:
birdybro
2021-04-19 10:05:16 -06:00
committed by GitHub
parent 187734d29b
commit fd6865de39
2 changed files with 45 additions and 61 deletions

45
README.md Normal file
View File

@@ -0,0 +1,45 @@
# [Arcade: New Rally-X](https://www.arcade-museum.com/game_detail.php?game_id=9259) for [MiSTer](https://github.com/MiSTer-devel/Main_MiSTer/wiki)
by [MiSTer-X](https://twitter.com/mrx_8b)
From: https://github.com/MrX-8B/MiSTer-Arcade-RallyX
## Description
A simulation model of the Midway Manufacturing Rally-X arcade hardware. Click the wikipedia link in the title for more information or search "Rally-X Arcade" in your favorite search engine to learn more.
## Games
* Rally-X (32k Version)
* New Rally-X
## ROM Files Instructions
**ROMs are not included!** In order to use this arcade core, you will need to provide the correct ROM file yourself.
Find this zip file somewhere. You need to find the file exactly as required. Check the .mra file in a text editor for more information.
Do not rename other zip files even if they also represent the same game - they are not compatible!
The name of zip is taken from M.A.M.E. project, so you can get more info about hashes and contained files there.
How to install:
1. Update MiSTer binary to v200106 or later
2. copy releases/*.mra to /media/fat/_Arcade
3. copy releases/*.rbf to /media/fat/_Arcade/cores
4. copy ROM zip files to /media/fat/_Arcade/mame
Be sure to use the MRA file in "releases" of this repository.
It does not guarantee the operation when using other MRA files.
## Copyright and License
```
---------------------------------------------------------------------------------
-- FPGA New Rally-X for Spartan-3 Starter Board
------------------------------------------------
-- Copyright (c) 2005 MiSTer-X
---------------------------------------------------------------------------------
-- T80/T80s - Version : 0242
-----------------------------
-- Z80 compatible microprocessor core
-- Copyright (c) 2001-2002 Daniel Wallner (jesus@opencores.org)
---------------------------------------------------------------------------------
```

View File

@@ -1,61 +0,0 @@
---------------------------------------------------------------------------------
--
-- Arcade: New Rally-X port to MiSTer by MiSTer-X
-- 18 September 2019
-- From: https://github.com/MrX-8B/MiSTer-Arcade-RallyX
--
---------------------------------------------------------------------------------
-- FPGA New Rally-X for Spartan-3 Starter Board
------------------------------------------------
-- Copyright (c) 2005 MiSTer-X
---------------------------------------------------------------------------------
-- T80/T80s - Version : 0242
-----------------------------
-- Z80 compatible microprocessor core
-- Copyright (c) 2001-2002 Daniel Wallner (jesus@opencores.org)
---------------------------------------------------------------------------------
--
--
-- Keyboard inputs :
--
-- F2 : Coin + Start 2 players
-- F1 : Coin + Start 1 player
-- UP,DOWN,LEFT,RIGHT arrows : Movements
-- SPACE/CTRL : Smoke
--
-- MAME/IPAC/JPAC Style Keyboard inputs:
-- 5 : Coin 1
-- 6 : Coin 2
-- 1 : Start 1 Player
-- 2 : Start 2 Players
-- R,F,D,G : Player 2 Movements
-- A/S : Player 2 Smoke
--
-- Joystick support.
--
--
---------------------------------------------------------------------------------
-- 22 October 2019
---------------------------------------------------------------------------------
-- FIXED: CRT video problems
-- CHANGE: Keyboard inputs
---------------------------------------------------------------------------------
*** Attention ***
ROMs are not included. In order to use this arcade, you need to provide the
correct ROMs.
To simplify the process .mra files are provided in the releases folder, that
specifies the required ROMs with checksums. The ROMs .zip filename refers to the
corresponding file of the M.A.M.E. project.
Please refer to https://github.com/MiSTer-devel/Main_MiSTer/wiki/Arcade-Roms for
information on how to setup and use the environment.
Quickreference for folders and file placement:
/_Arcade/<game name>.mra
/_Arcade/cores/<game rbf>.rbf
/_Arcade/mame/<mame rom>.zip
/_Arcade/hbmame/<hbmame rom>.zip