Add a brief README 0.0.1

1 files changed, 36 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..537a251
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# Taosc
+
+Taosc is an automated makeshift patcher for binary programs.
+
+## Installation
+
+Taosc depends on [AFL++], [AFL Dyninst], [Dyninst], [E9Patch], [PatchELF]
+[pacfix-python], and [GNU Parallel].  To build taosc, you need
+`make(1)`, a compiler for C and C++, [GNU M4], and `link(1)`:
+
+    make -j$(nproc)
+
+To install taosc to `$prefix`, you'll also need install(1):
+
+    make PREFIX=$prefix install
+
+## Usage
+
+    taosc-fix executable address workdir option...
+    taosc-fix-lib executable library address workdir option...
+
+## Copying
+
+Taosc is free software: you can redistribute it and/or modify it
+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
+[AFL Dyninst]: https://trong.loang.net/~cnx/afl-dyninst
+[Dyninst]: https://github.com/dyninst/dyninst
+[E9Patch]: https://github.com/gjduck/e9patch
+[PatchELF]: https://github.com/NixOS/patchelf
+[pacfix-python]: https://github.com/hsh814/pacfix-python
+[GNU Parallel]: https://www.gnu.org/software/parallel
+[GNU M4]: https://www.gnu.org/software/m4