summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authornorly <ny-git@enpas.org>2019-02-14 14:19:23 +0100
committernorly <ny-git@enpas.org>2019-02-14 14:19:23 +0100
commitb8be4e60cd44abb9bbf76daf751ddd2f31a5f8b8 (patch)
tree8a596aa55502e5e1572ad2291102eeb60e069d57
parent7f06301736d9f9164a6a8f4d29c7f4b18f7e70a2 (diff)
README.md: List libraries and tools used, explain differente to ADFscan
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8034130..defa1fb 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,18 @@ If you abort the process by pressing Ctrl+C, there will be
stale files in /tmp.
+Libraries used
+---------------
+
+This script makes use of the following tools and libraries:
+
+ - CheckX - the virus scanner
+ - xvs.library - virus signature collection
+ - xadmaster.library - archive unpacker (`.lha`, `.adf`, ...)
+ - xfdmaster.library - decruncher (for packed executables, ...)
+ - UAEquit - to shut down the emulator when done.
+
+
Dependencies
-------------
@@ -62,6 +74,13 @@ Aminet unless they have already been cached locally.
See `installer_urls` for details.
+It requires the following tools to be installed on the host:
+
+ curl
+ lha
+ fs-uae
+ sha256sum
+
Security
---------
@@ -76,6 +95,19 @@ virus scanner, it won't be able to break the host unless it
also breaks FS-UAE.
+Comparison to similar tools
+----------------------------
+
+- ADFscan: The original inspiration for this project.
+ This is a Visual Basic application scanning for only a
+ handful of the most common signatures. It has its own
+ unpacker for Amiga OFS to be able to scan ADFs.
+
+ + amiga-uae-virus-scan uses well-known Amiga libraries and
+ tools to perform these tasks, allowing it to detect more
+ viruses and unpack more formats, by order(s) of magnitude.
+
+
Thanks
=======