about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/README.md b/README.md
index 682632d..e30b715 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ Taosc is an automated makeshift patcher for binary programs.
 
 ## Installation
 
-Taosc depends on GDB, [Dyninst], [E9Patch], [FUZZOLIC], [GNU Parallel]
+Taosc depends on [AFL++], [Dyninst], [E9Patch], [GNU Findutils], [FUZZOLIC]
 and POSIX utilities.  To build taosc, you need [GNU M4] and a compiler
 for C++23 and [Zig] 0.15:
 
@@ -16,7 +16,15 @@ To install taosc to `$prefix`, you'll also need `install(1p)`:
 
 ## Usage
 
-    taosc-fix WORKDIR TIMEOUT EXECUTABLE PROOFS_OF_CONCEPT [OPTION]...
+    taosc-fix TIMEOUT WORKDIR PROOFS_OF_CONCEPT EXECUTABLE ARG...
+
+Fix `EXECUTABLE`, which crashes for PoC(s) in the `PROOFS_OF_CONCEPT` directory
+when it is run with `ARG`(s), where `@@` is the placeholder for input files.
+
+Processes taking more than `TIMEOUT` seconds to terminate
+are treated the same as crashes.
+
+Files in `WORKDIR` are overwritten without any warning.
 
 ## Copying
 
@@ -25,9 +33,10 @@ under the terms of the GNU Affero General Public License as published
 by the Free Software Foundation, either version 3 of the License,
 or (at your option) any later version.
 
+[AFL++]: https://aflplus.plus
 [Dyninst]: https://github.com/dyninst/dyninst
 [E9Patch]: https://github.com/gjduck/e9patch
+[GNU Findutils]: https://www.gnu.org/software/findutils
 [FUZZOLIC]: https://season-lab.github.io/fuzzolic
 [GNU M4]: https://www.gnu.org/software/m4
-[GNU Parallel]: https://www.gnu.org/software/parallel
 [Zig]: https://ziglang.org