*************************************************
*  vMac/DOS README				*
*  Port by:					*
*  David Bacher (dbacher@ibm.net)		*
*  Marcus Childs (m.childs@internetmc.com)	*
*  README by Ray Ruvinskiy (rruvin@sprint.ca)	*
*			   (rruvin@idirect.com)	*
*************************************************

NOTE: 	Using this software shows your acceptance to the End User License
        Agreement which was shown to you before downloading vMac.
        If you have not read or accepted it, you are not entitled
        to use this software!!!
        Please read EULA.TXT (located in the same directory as the readme),
        make sure you understand it and accept its terms. If you don't
        accept vMac's End User License Agreement, please delete vMac from 
	your machine.

0. Brief introduction
1. Getting vMac
2. Installing vMac
3. Running vMac
4. While vMac is running...
5. Troubleshooting
6. How to help...
7. Additional features
8. OS/2 FAQ

0. Brief introduction
---------------------

What is vMac? vMac is a free software emulator that emulates the Apple
Macintosh Plus(tm). That means that vMac does not cost anything, and
does not use any hardware. A lot of the Macintosh Plus' functionality is
already implemented in this port, and that includes: 

- 68000 CPU, 68010 CPU, 68020 CPU + 68881 FPU emulation
- 4 MB of RAM
- Keyboard support
- Mouse support
- Floppy drive support
- HardDrive support (vMac can now mount all HFS media; however, vMac will
			treat all media as floppy disks)
- Can run MacOS (System Software) versions up to 7.5.5

Currently, work is being done on IceCube, a new CPU emulator that would
replace UAE's CPU emulator which we use currently, Hard Disk suppport,
and other stuff :).

The system requirements for vMac are:

- OS/2 Warp 3.0 revision 17 *required*
  OS/2 Warp 4.0 highly recommended
- 80486 with a 80487 FPU
- A Video card with support for DIVE
  A Pentium 133 recommended
- A minimum of 8 MB of RAM
  16 MB of RAM recommended
- Mouse
- About 3 - 4 MB of harddrive space for minimum install (vMac + ROM file + disk image)
  15 - 20 MB of harddrive space recommended (You do want to use some Mac software
  with vMac, right?)

1. Getting vMac
---------------

vMac's homepage is at http://www.vMac.org. If that doesn't work, try
http://leb.net/vmac. If *that* doesn't work, try again another day, the
site is probably down :\. Click on the Download link, fill a few
blanks and download vMac. If you are reading this, however, you have
probably already downloaded vMac. This section is here just in case...

2. Installing vMac
------------------

Unzip the file you downloaded into a directory of your choice.
You have to have a ROM in a file taken from a real Macintosh Plus in order
to use the emulator.

NOTE: LEGALLY, YOU HAVE THE RIGHT TO USE A MAC ROM _ONLY_ IF YOU OWN A
REAL MAC PLUS. ALSO, YOU MUSTN'T USE YOUR REAL MAC AND HAVE vMac RUNNING
AT THE SAME TIME.

If you do not have a ROM in a file, and you do own a real Macintosh
Plus, read the file vmac_rom.txt.

You also need a System Software disk image. System 6.0.8, System 7.0,
and System 7.0.1 are distributed freely and can be downloaded from
Apple's FTP site (ftp://ftp.apple.com), or the vMac Application Site
(VAS - http://www.hostus.com/vas). A considerably large selection of
Macintosh applications and games can also be found on VAS.

Once you've got your ROM and MacOS disk image, edit vMac.cfg and modify
it to suite your system (and desires). All options are self explanatory.
For example: to boot off Disk1.dsk put "Disk1.dsk" (without the quotes) 
beside DrivePath1=.

To boot off a real floppy put "A:" besides DrivePath1 (if your HFS formatted
floppy is in drive A:, and you want to mount it as the first disk in vMac).

To mount an HFS formatted HDD or any other media put the drive letter that
corresponds to that media in OS/2 besides "DrivePathx".

3. Running vMac
---------------

There are four binaries - vmac.exe for vMac with a 68000 CPU, vmac010 for
vMac with a 68010 CPU, vmac020.exe for vMac with a 68020 CPU and vmac881.exe
for vMac with a 68020 CPU + 68881 FPU. In the examples in this README we will
always use "vmac". Note, however, that you can always substitute "vmac" with
of the above mentioned filenames.

Launch vMac (by typing "vmac") and if everything is alright, vMac should boot
within a minute. Voila, you can run Macintosh software on your PC.

4. While vMac is running...
---------------------------

The default keyboard mappings

  Alt     : This key emulates the Command [or Pretzel] key on the Mac.
  Ctrl    : This key emulates the Option key on the Mac.
  Shift   : This key emulates the Shift key on the Mac.
  CapsLock: This key emulates the CapsLock key on the Mac.
  Keypad  : The gray keypad emulates the Macintosh Plus keypad.
            The regular [white] keypad acts like under Num-Lock.
 
5. Troubleshooting
------------------

This section currently deals with very elementary stuff. Hopefully
(or then again, maybe not) it will be expanded in the future.

A) When vMac starts, a floppy with a question mark on it appears - the
   Mac can't find your disk image/parition/floppy. Double check the path.

B) When vMac starts, a floppy with an X on it appears - the Mac can't
   boot off your floppy/disk image/partition.

C) It takes longer for vMac to boot when I run it with 4 MB RAM than
   when I run it with 1 MB of RAM - this is natural. It takes time to
   check for all that RAM. In this version, however, you can disable
   the memory in vMac.cfg.

D) MacOS 7.6 and higher won't boot! - MacOS version 7.6 and higher don't even
   work on a real Macintosh Plus. Downgrade...

E) vMac is running incredibly slowly with MacOS x.x.x - You might have a
   slow machine. You might try to remove extensions and control panels
   from System Folder:Extensions and/or System Folder:Control Panels.
   You might not have enough RAM on your machine. You might want to try to
   downgrade your MacOS version. You may want to try using the 68000 
   binary if you're using the 68020 one. You may want to try to increase the
   frame rate (video quality will be worse though).

F) When I try to boot System 7 or higher, the Mac writes something like
   "You need more RAM to boot this version of the System Software" - 
   tell vMac to emulate more RAM.

G) The System 7.0.1/System 7.1 disk image I downloaded from VAS doesn't work - 
   Some people have problems downloading from VAS. Try downloading a couple of
   times. If you still don't succeed, there's nothing we can do, so stop e-mailing
   the port authors about it! :-)

To get help with any other problem, e-mail the port author.

6. How to help...
-----------------

If you'd like to help, please e-mail the port author you want to help to.
The e-mail addresses of porters are located on vMac's site
(http://www.vMac.org), in the Port Roster. We appreciate all help we can 
get so if you are able/willing to donate some of your time, we'll probably 
find something for you to do.

7. Additional Features...
-------------------------

The OS/2 version of vMac provides Icons to access the following features:
   Setup - This Icon brings up a tabbed dialog box to configure vMac.  Changes
           are written to the configuration file, and all available options are
           shown.
   Disk  - There is an Icon for each disk.  This will bring up a dialog box to
           allow you to access a disk or disk image.  If you have a .dsk file
           on your hard drive, select Image, if you have a real disk of some
           form, select Drive.

8.  OS/2 FAQ...
---------------

A) Do I need EMXRT.DLL or a similar file to run vMac for OS/2?

   No.  vMac is compiled with Watcom C++ 10.6, and is self contained.  You will
   need to install the Multimedia Support in OS/2, however, for this release.

B) What versions of OS/2 is vMac compatible with?

   Version 3.0 Fixpack 17 or newer, and all Version 4 systems are supported.  You
   must have Multimedia Support installed, however.

C) Where is vMac.cfg located?  It doesn't seem to take effect when I change the one
   in the vMac directory.

   Do to changes in the X-Windows version, from which this version is derived, the
   vMac.cfg file is now stored in your home directory, if it is defined.  The home
   directory (in OS/2) can be set by typing "SET HOME=<directory" in Config.Sys.
   If a home directory is not defined, vMac will store the file in the current
   directory.

D) How do I mount a real 3.5" disk?

   Insert the disk into drive A.  In vMac, make sure that one of the three floppy
   drives is available, and then click on its Icon.  A window will appear with
   two radio buttons -- choose Disk Drive, and make sure the edit box says A:\.
   Click on OK.  You can mount any disk drive this way.  vMac can not currently
   format floppies because it thinks that the disk drive is an 800k drive.

E) How do I mount an IoMega Zip 100, Jaz 1g, Jaz 2g or Syquest EzDrive cartridge?

   See instructions for mounting a floppy.  Use the drive letter of your drive
   instead of A.

F) The mouse seems kinda slow, and the keyboard lags behind a little.

   Due to how we had to do the code to prevent OS/2 4 from believing that vMac had
   locked the system on slow machines, this minor annoyance must just be tolerated.
   We are working on it.  The mouse is "polled" 60 times a second.

G) What happened to the Skip Frames if Behind box?
   
   The code always skips frames when it falls behind now.  The option was removed.

H) What happened to the Vertical Blank Rate box?

   The code sends *EXACTLY* sixty blanks per second now.  The code evenly spaces
   these over the course of a second.  If you don't want 60 screen redraws, use
   the Frame Rate option on the Performance tab.

I) The splash screen window is way too big for the image...

   Run at 640 x 480.  We're working on it, but at the moment I'm expecting a new C
   compiler any day, and want to postpone fixing the code until it arrives.  It only
   effects the splash screen, so it's sorta a low priority.

J) The new version seems alot faster.

   We changed C compilers from Watcom to IBM Visual Age for C++.  Watcom had gained
   us a significant improvement over EMX, and IBM's gained us a 50% improvement over
   Watcom.  If you're running an AMD K6 200, you should score around three times a
   Mac Plus.