From b8be4e60cd44abb9bbf76daf751ddd2f31a5f8b8 Mon Sep 17 00:00:00 2001 From: norly Date: Thu, 14 Feb 2019 14:19:23 +0100 Subject: README.md: List libraries and tools used, explain differente to ADFscan --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) 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 ======= -- cgit v1.2.3