summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f37f3a9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+<!--
+SPDX-FileCopyrightText: 2026 Terin Stock <terinjokes@gmail.com>
+SPDX-License-Identifier: EUPL-1.2
+-->
+# SCSI Toolbox for (Optical) Drive Emulators
+
+An implementation of the "SCSI Toolbox" for SCSI emulators, written in Go and targetting modern operating systems.
+The project provides a Go library and a simple CLI interface.
+
+This project has been tested with:
+
+* [USBODE](https://github.com/danifunker/usbode-circle)
+
+It may also work with the BlueSCSI and ZuluSCSI projects, but I do not currently have these devices to test with.
+
+## Status
+
+The project currently only supports devices on Linux with the "SCSI Generic" interface.
+
+* Listing images
+* Switching active image
+* Enumeate emulated device types
+
+There is currently no support for uploading or downloading files from the emulator.
+
+## Related Projects
+
+* [escsitoolbox](https://github.com/nielsmh/escsitoolbox): Supports MS-DOS, Windows 3.x, and Windows 98.