*************************************************
*  vMac/DOS README				*
*  Port by Yoav Shadmi (yoav@nettaxi.com)	*
*  README by Ray Ruvinskiy (ray@ocotnline.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 go back to the Download Page on vMac's site
        (http://www.vMac.org) and thoroughly examine the End User License
        Agreement!
                                                                            	
0. Brief introduction
1. Getting vMac
2. Installing vMac
3. Running vMac
4. While vMac is running...
5. Troubleshooting
6. How to help...

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
- 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:

- MS DOS 5.0 or higher
- 80386 with a 80387 FPU
  A Pentium 133 recommended
- A minimum of 8 MB of RAM
  16 MB of RAM recommended
- Mouse
- About 3 - 5 MB of harddrive space for minimum install (vMac + ROM file + disk image)
  15 - 20 MB of harddrive space recommended (You do want to use 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=.

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

There are four binaries - "vmac.exe" for vMac with a 68000 CPU, "vmac010.exe"
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 (or less, depends on your hardware speed). Voila, you can run
Macintosh software on your PC.

If you want to enter debug mode you can press F9 at any time during the 
emulation.

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.
  F1      : Inserts disk in drive 1
  F2      : Inserts disk in drive 2
  F3      : Inserts disk in drive 3
  F4      : Inserts disk in drive 4
  F9      : Enter online debug mode [enter "h" or "?" for debug help]
  F10     : This will close vMac
  F11     : This key emulates the Interrupt/Programmer Switch of the
            Macintosh Plus.
  F12     : This key emulates the Reset Switch of the Macintosh Plus.

The keyboard mapping [for option/command and F-keys] can be re-defined
through the config file.

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.

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.

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 "Developers" section (login as "Guest"),
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.
