Expanded README with further links, a better overview, and basic usage instructions.

This commit is contained in:
Morgan Aldridge 2016-12-08 17:15:45 -05:00
parent 8433c298cd
commit f271415062
1 changed files with 15 additions and 2 deletions

View File

@ -5,12 +5,25 @@ by Morgan T. Aldridge <morgant@makkintosshu.com>
OVERVIEW
--------
`basiliskiivm` is a quick utility I hacked together to package up [BasiliskII](https://github.com/cebix/macemu/) emulator prefs & disk images into a single `.basiliskiivm` directory to make them easier to manage, move, launch, and maintain multiple VMs.
`basiliskiivm` is a utility I tossed together to package up [BasiliskII](https://github.com/cebix/macemu/) emulator (see [Emaculation's wiki](http://www.emaculation.com/doku.php/basilisk_ii) for further details) preferences & disk images into a single `.BasiliskIIVM` directory for each configuration to make it easier to manage, move, launch, and maintain multiple VMs. Think of it as the equivalent to VirtuaBox's [`VBoxManage`](https://www.virtualbox.org/manual/ch08.html), VMware Fusion's `vmrun`, or Parallels Desktop's [`prlctl`](http://kb.parallels.com/en/112013).
USAGE
-----
_TBD_
If you have already have a `.BasiliskIIVM` generated, you can launch it by running `basiliskiivm start <vm_name>.BasiliskIIVM` (replacing "<vm_name>" with the name of your BasiliskII VM name).
While not yet implemented, you will be able to package your existing BasiliskII configuration (for example, one you've configured & tested with `BasiliskIIGUI`) into a `.BasiliskIIVM` directory by running `basiliskiivm package <vm_name>.BasiliskIIVM`. This will take your `~/.basilisk_ii_prefs` file, the ROM file, and disk images that are specified in it, and move them into the specified `.BasiliskIIVM` directory.
Run `basiliskiivm -h` for further usage instructions.
`.BasiliskIIVM` Structure
-------------------------
Each `.BasiliskIIVM` directory contains all the configuration settings & data (including disk images) needed to run BasiliskII. This makes it very easy to move, backup, or run multiple individual VMs. Each directory contains:
* The BasiliskII `.basilisk_ii_prefs` preferences/configuration file.
* The ROM file
* Any number of disk images
LICENSE
-------