Apple-2-Tools
/
Driv3rs
mirror of https://github.com/thecompu/Driv3rs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated Readme.md with markdown

This commit is contained in:
ultramagnus_tcv 2015-12-10 10:26:59 -06:00
parent 7336257383
commit a93db92b48
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Readme.md
View File

@ -1,10 +1,10 @@
Driv3rs.py -- A script to help catalog SOS.DRIVER files.
#Driv3rs.py -- A script to help catalog SOS.DRIVER files.
Usage: $python Driv3rs.py [SOS_DRIVER_FILE] [output_file.csv]
##Usage: `$python Driv3rs.py [SOS_DRIVER_FILE] [output_file.csv]`
Description:
##Description:
Driv3rs.py is a Python script written for Apple /// fans. The Apple /// was one of the first computers to introduce the concept of device drivers, small programs that allowed a user to interact with hardware on-board, internally installed, or attached to the computer externally. Over the course of the few years of the Apple ///'s existence, hardware manufacturers built devices and wrote device drivers to support those devices. However, the Apple /// simply didn't achieve as much prominence as the Apple II-series. Therefore, a lot of drivers remain either undiscovered or long-forgotten.
**Driv3rs.py** is a Python script written for Apple /// fans. The Apple /// was one of the first computers to introduce the concept of device drivers, small programs that allowed a user to interact with hardware on-board, internally installed, or attached to the computer externally. Over the course of the few years of the Apple ///'s existence, hardware manufacturers built devices and wrote device drivers to support those devices. However, the Apple /// simply didn't achieve as much prominence as the Apple II-series. Therefore, a lot of drivers remain either undiscovered or long-forgotten.
Driv3rs.py hopes to help that situation. Given an SOS.DRIVER file properly exported from an imaged Apple /// disk, Driv3rs.py can produce a Comma Separated Values (CSV) file. This CSV contains a whole host of information including device name, commentary, manufacturer, among many other potentially useful pieces of information.
@ -12,14 +12,14 @@ When using an Apple ///, users would run a utility called the System Configurati
Driv3rs.py works by opening the SOS.DRIVER file and then walks the Device Information Block (DIB) for every driver found within. The information gathered closely parallels the outlined DIB published in Apple's "Apple /// SOS Device Driver Writer's Guide." All information is eventually stored in the output CSV file.
Requirements:
##Requirements:
* Imaged Apple /// disk
* SOS.DRIVER files to be searched
* AppleCommander
* Java for AppleCommander (Java 6 if you want to use AppleCommander's GUI).
Suggested Workflow:
##Suggested Workflow:
1. Acquire an imaged Apple /// floppy disk.
2. Use AppleCommander's CLI functions to export the SOS.DRIVER file from the imaged disk. (See notes below on AppleCommander usage.)
@ -29,9 +29,9 @@ Suggested Workflow:
Depending upon the name you chose for the output file, a CSV file will be generated with driver information found inside the SOS.DRIVER file.
(Note: If you choose the output name of a CSV file that already exists, Driv3rs.py will append the new SOS.DRIVER file's contents to the existing CSV file. This is handy if you're processing multiple SOS.DRIVER files.)
(**Note:** If you choose the output name of a CSV file that already exists, Driv3rs.py will append the new SOS.DRIVER file's contents to the existing CSV file. This is handy if you're processing multiple SOS.DRIVER files.)
Notes about AppleCommander:
##Notes about AppleCommander:
AppleCommander is a utility written in Java for Apple II users. It allows manipulation of many different types of Apple II-based imaged floppy disks, including disks formatted in DOS 3.2, 3.3 and ProDOS. Apple's Sophisticated Operating System (SOS) is ProDOS's predecessor. Therefore, AppleCommander ProDOS features can be used to easily export files from SOS disks.
@ -39,4 +39,8 @@ Because AppleCommander is written in Java, you must have Java on your workstatio
Here's the suggested command-line to enter when exporting using AppleCommander.
$java -jar AppleCommander-1.3.5.13-ac.jar -g [ImagedDisk.dsk] [SOS.DRIVER] [ExportedFilename]
`$java -jar AppleCommander-1.3.5.13-ac.jar -g [ImagedDisk.dsk] [SOS.DRIVER] [ExportedFilename]`
##Links:
AppleCommander: (http://applecommander.sourceforge.net/)
Java: (https://www.java.com/en/download/)