From f2714150629bb59def86409d90dbc292cb5ba05b Mon Sep 17 00:00:00 2001 From: Morgan Aldridge Date: Thu, 8 Dec 2016 17:15:45 -0500 Subject: [PATCH] Expanded README with further links, a better overview, and basic usage instructions. --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index aa0e655..f8eb6f6 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,25 @@ by Morgan T. Aldridge 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 .BasiliskIIVM` (replacing "" 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 .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 -------