From 8ff85a34d834b5a43bb525ec023b60692e340f2e Mon Sep 17 00:00:00 2001 From: Daniel Brooks Date: Fri, 27 Feb 2015 16:42:56 -0800 Subject: [PATCH] improve readme a bit: IA, known issues --- README.md | 35 +++++++++++++++++++++++------------ 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 7ffa4af7..e0cbda7c 100644 --- a/README.md +++ b/README.md @@ -52,29 +52,40 @@ Each of these is configured by calling a constructor function and providing it w ## Common ## -* emulatorJS(url) -* mountZip(drive, file) -* mountFile(filename, file) -* fetchFile(url) -* fetchOptionalFile(url) -* localFile(data) +* `emulatorJS(url)` +* `mountZip(drive, file)` +* `mountFile(filename, file)` +* `fetchFile(url)` +* `fetchOptionalFile(url)` +* `localFile(data)` ## JSMESS ## -* driver(driverName) -* extraArgs(args) -* peripheral(name, filename) +* `driver(driverName)` +* `extraArgs(args)` +* `peripheral(name, filename)` ## JSMAME ## -* driver(driverName) -* extraArgs(args) +* `driver(driverName)` +* `extraArgs(args)` ## EM-DosBox ## * startExe(filename) +# Internet Archive # + +There's also a helper for loading software from [the Internet Archive](https://archive.org/v2), `IALoader`. IALoader looks at the metadata associated with their items and uses that to build the configuration for the emulator. + +## Examples ## + + var emulator = IALoader("#canvas", "atari_2600_pitfall_1983_cce_c-813/atari_2600_pitfall_1983_cce_c-813.bin"); + # Known Bugs # * splash screen doesn't always fit inside the canvas -* not enough indication of download progress +* need to improve the download progress indicators +* browser feature detection for volume/mute/full-screen +* handling of aspect ratios, and their interaction with full-screen mode +* finish API for volume/mute/full-screen requests