Updated README.md

This commit is contained in:
Marcio T 2021-11-25 10:45:18 -07:00
parent dac8e9009d
commit 065b38d1e2
1 changed files with 69 additions and 38 deletions

107
README.md
View File

@ -5,12 +5,23 @@ TIP for 68k and PowerPC Macintosh
This is the repository for a Macintosh port of [Gibson Research Corp]'s
[Trouble in Paradise], a diagnostic and repair tool for Iomega Zip and
Jaz Drives.
Jaz Drives. A big thanks goes to Steve Gibson for the x86 source that
made this project possible!
Compatibility
-------------
This tool is meant for Macintosh computers with a SCSI port, which
range from the Macintosh Plus, released in 1986, through the "Beige"
Power Macintosh G3, released in 1997.
It has been tested in on the following environments:
| Computer | Memory | System | Drive |
|-----------------|--------|--------|---------------------|
| Macintosh Plus | 4MB | 7.0.1 | Iomega Zip Plus 100 |
| PowerBook 3400c | 144MB | 8.6 | Iomega Zip 100 |
Disclaimer
----------
@ -20,17 +31,6 @@ the original by GRC, I may have introduced errors during the conversion
process. Please do not reach out to GRC for support on this Macintosh
port.**
How Can You Help?
-----------------
You can help this project in one of the following ways:
* Star this project to show your support!
* Sign up to [beta test in the discussion forum](https://github.com/marciot/mac-tip/discussions/1#discussion-3704575)!
* Donate a 1 or 2GB Jaz cartridge so I can do some testing with that (I have a 2GB SCSI Jaz drive, but I do not have a cartridge).
* Become a GitHub sponsor to help fund my open-source projects!
* If you have consulting work, in particular contract work pertaining to retro-computers or THREE.js, please hit me up via my [GitHub account]!
Where are the binaries?
-----------------------
@ -38,51 +38,82 @@ Right now the port is in early testing, so I am not releasing any
compiled binaries. There is always a risk of data loss with a tool like
this, so please post in the discussion forum if you want to beta test.
Command console
---------------
How can you help?
-----------------
When you first start the program, you will be greeted with a Command
Console. This is a unique feature of this port and is not present in
the original TIP:
You can help this project in one of the following ways:
* Star this project on GitHub to show your support!
* Sign up to [beta test in the discussion forum](https://github.com/marciot/mac-tip/discussions/1#discussion-3704575)!
* Donate a 1 or 2GB Jaz cartridge for testing (I have a 2GB SCSI Jaz drive, but no cartridges!).
* Become a GitHub sponsor to help fund my work with this and other open-source projects!
Got work?
---------
I am open to paid consulting work related to retro-computing or software
for vintage Macs. If you have a project in mind, please hit me up via my
[GitHub account]!
Unmounting volumes using the Command Console
--------------------------------------------
**To avoid data corruption, you must "unmount" the cartridge prior to
starting a test with TIP**
There is no way to unmount a cartridge (without also ejecting it) in the
Finder, but the program will start out with a Command Console that allows
you to do this and other things.
<details>
<summary>Click here to learn how to use the Command Console</summary></br>
The Command Console is a unique feature of this port and is not present
in the original TIP:
![Command Line][mac-screenshot2]
**Before launching TIP, you will need to do some prep work. It is *vitally
important* that you unmount the Zip cartridge prior to running TIP on it.**
Unmounting is different than ejecting a cartridge. Once a Zip cartridge is
unmounted, the icon will disappear from the Finder, but the cartridge will
remain in the drive.
There is no way to unmount a cartridge without ejecting it in the Finder,
but you may do it via the Command Console like this:
Start by inserting the disk you want to test. The disk will show up in the
Finder as an icon; MacOS calls this a "volume". To prevent data corruption,
you have to "unmount" the volume prior to testing. When a volume is unmounted,
the icon will disappear from the Finder, but the cartridge will remain in the
drive. To unmount a drive:
* Type `volumes` to show a numbered list of all Mac volumes
* Type `unmount` followed by a volume's number to unmount it.
Once you have the Zip cartridge unmounted, you will need to tell TIP which
SCSI device to use.
*The unmount process will fail if you have any open files or applications in
the volume. If this happens, close those files and try again.*
Once you have the cartridge unmounted, you will need to tell TIP which
SCSI device to use:
* Type `list` to show a numbered list of all SCSI devices by SCSI ID.
* Type `tip` followed by a SCSI ID to run TIP on that device.
At the present, I am unable to find any documented MacOS APIs for
automatically unmounting volumes associated with a SCSI ID. Future versions
may simplify the process if I find out how to do this.
Future versions of this tool may eliminate these manual steps or the
Command Console, if I can find the right way to do this in MacOS :grin:
</summary></br>
About the code
--------------
Portions of the original code have been re-written in C++ and adapted
for compilation using [Metrowerks CodeWarrior 8 Gold]. Native
[Macintosh SCSI Manager] routines have been substituted for the Win32
ASPI routines and the UI has been re-created as closely as possible
using QuickDraw routines.
for compilation using [Metrowerks CodeWarrior 8 Gold].
<details>
<summary>Click here to learn more about the code</summary></br>
Native [Macintosh SCSI Manager] routines have been substituted for
the Win32 ASPI routines and the UI has been re-created as closely as
possible using QuickDraw routines.
Although the source code is materially different, I have maintained the
layout and routines names of the original code to allow for easy cross
referencing with the original code and to make it easy to port additional
functionality in the future.
layout and routines names of the original assembly code to allow for easy
cross referencing and to make it easy to port additional functionality
in the future.
</details>
The Original TIP For Windows
----------------------------