diff README @ 1017:216fa63749b3

Added documentation for lock-on support and a fullscreen config option.
author Michael Pavone <pavone@retrodev.com>
date Mon, 02 May 2016 21:35:19 -0700
parents ef923c4b8977
children 58e3d50f6a4e
line wrap: on
line diff
--- a/README	Mon May 02 21:06:12 2016 -0700
+++ b/README	Mon May 02 21:35:19 2016 -0700
@@ -26,6 +26,19 @@
 From within your BlastEm directory. On Windows type:
 	
 	blastem.exe -h
+	
+Lock-On Support
+---------------
+
+This version of BlastEm has some preliminary support for Sonic & Knuckles lock
+on technology. This is only available from the command line at the moment. To
+use it specify the Sonic & Knuckles ROM as the primary ROM and specify the ROM
+to be locked on using the -o option. As an example:
+
+	./blastem ~/romz/sonic_and_knuckles.bin -o ~/romz/sonic3.bin
+	
+Please note that Sonic 2 lock-on does not work at this time. Additionally the
+save RAM added by Sonic 3 won't work either.
 
 Configuration
 -------------
@@ -106,6 +119,11 @@
 enabled. These issues will be addressed in a future release. If you wish to use
 vsync, please see the VSync section at the bottom of the README.
 
+"fullscreen" controls whether BlastEm starts in fullscreen or windowed mode.
+This can be overridden on the command line with the -f flag. If fullscreen
+is set to "off", -f will turn it on. Conversely, if fullscreen is set to "on"
+in the config, -f will turn it off.
+
 Audio
 -----