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..29d88a9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+This project helps build a static binary for Tor.
+
+Some inspiration is taken from the
+[tor-static](https://github.com/cretz/tor-static) Go library.
+
+# Versions
+
+This repo builds:
+
+- Libevent 2.1.8
+- OpenSSL 1.1.1b
+- Tor 0.4.0.5
+- zlib v1.2.11
+
+# Requirements
+
+- A proper C compiler toolchain.
+- Make
+- Autotools
+
+The build has only been tested on Linux so far.
+
+# Usage
+
+- Make sure you have all the required dependencies..
+- Run `./build.sh`
+- Wait.
+- Discover that you suddenly have a working `tor-static` binary.