Self review

mattgodbolt · Dec 19, 2024 · fb01a90 · fb01a90
1 parent 780c3d9
commit fb01a90
Show file tree

Hide file tree

Showing 7 changed files with 1,961 additions and 100 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
 Miracle - a Javascript Sega Master System emulator
 --------------------------------------------------
 
-TODO RE-DOCUMENT AND TEST
-
-Requires `make`, `perl` and `python` to build.  Place ROMs in the `roms` directory as
+Requires `make`, `perl` and `python` to build.  Place ROMs in the `public/roms` directory as
 `romname.sms` and then run `make` to build the emulation script files and the ROM data.
 
+To run locally run `npm run dev` and then go to http://localhost:5173.
+
 z80 emulation and test are based on rev 1071 of http://svn.matt.west.co.tt/svn/jsspec/trunk
 
 Miracle can be taken for a spin at https://miracle.xania.org/