Permalink
Browse files

tweak a few things with the documentation that I happened to notice

  • Loading branch information...
db48x committed Aug 10, 2016
1 parent ff20194 commit 6847994a75a0e40578a71f158bd26647c4ecda9e
Showing with 13 additions and 5 deletions.
  1. +2 −2 README.md
  2. +11 −3 TECHNICAL.md
View
@@ -17,9 +17,9 @@ The Emularity system has been used by millions of users at the [Internet Archive
Currently works with three emulators:
## JSMESS ##
## MAME ##
[JSMESS](https://github.com/jsmess/jsmess) is a port of the Multi Emulator Super System (MESS) and the Multiple Arcade Machine Emulator (MAME) projects to Javascript. MESS and MAME support thousands of different machines including game consoles, arcade machines and computer platforms.
[MAME](https://github.com/mamedev/mame) is a port of the Multiple Arcade Machine Emulator (MAME) projects to Javascript. MAME supports over a thousand different machines including game consoles, arcade machines and computer platforms.
## EM-DOSBox ##
View
@@ -10,8 +10,8 @@ function which returns a `Promise` of a config.
# Acquiring Emulators #
The Internet Archive is currently maintaining two sets of emulators -
one for MAME and one for EM-DOSBOX. They can be found at:
The Internet Archive is currently maintaining two sets of pre-built
emulators - one for MAME and one for EM-DOSBOX. They can be found at:
* [Emularity Engines: Arcade (MAME)](https://archive.org/details/emularity_engine_jsmame)
* [Emularity Engines: Computers and Consoles (MAME)](https://archive.org/details/emularity_engine_jsmess)
@@ -21,6 +21,11 @@ Note that MESS and MAME used to be separate, if related,
projects. They've recently been combined into a single source code
repository and prjoject structure, and Emularity has changed to match.
Instructions for building these yourself will be added in the future.
[The Scripted Amiga Emulator](https://github.com/naTmeg/ScriptedAmigaEmulator)
is much simpler to build, as it is already written in Javascript.
# Configuration #
## Examples ##
@@ -158,13 +163,16 @@ that we don't break existing users.
## Internet Archive ##
There's also a helper for loading software from
[the Internet Archive](https://archive.org/v2), `IALoader`. IALoader
[the Internet Archive](https://archive.org/), `IALoader`. IALoader
looks at the metadata associated with an Internet Archive item and
uses that to build the configuration for the emulator by calling
one of the other loaders as necessary.
## Examples ##
You need only supply the canvas element and the Internet Archive's
item name:
var emulator = new IALoader(document.querySelector("#canvas"),
"Pitfall_Activision_1982");

0 comments on commit 6847994

Please sign in to comment.