]> git.ipfire.org Git - thirdparty/tor.git/commitdiff
Add a README for the trunnel directory
authorNick Mathewson <nickm@torproject.org>
Tue, 29 Sep 2015 11:43:12 +0000 (13:43 +0200)
committerNick Mathewson <nickm@torproject.org>
Tue, 29 Sep 2015 11:43:12 +0000 (13:43 +0200)
src/trunnel/README [new file with mode: 0644]
src/trunnel/include.am

diff --git a/src/trunnel/README b/src/trunnel/README
new file mode 100644 (file)
index 0000000..383272c
--- /dev/null
@@ -0,0 +1,10 @@
+This directory contains code for use with, and code made by, the
+automatic code generation tool "Trunnel".
+
+The .trunnel files are the inputs here; the .c and .h files are the outputs.
+To regenerate the .c and .h files, run "scripts/codegen/run_trunnel.sh".
+
+For the Trunnel source code, and more documentation about using Trunnel,
+see https://gitweb.torproject.org/trunnel.git , especially
+    https://gitweb.torproject.org/trunnel.git/tree/README
+and https://gitweb.torproject.org/trunnel.git/tree/doc/trunnel.md
index 9bf37fe58b62a5b2ac2d61cc0e0ee56ab262a16c..b1448b7cb2738976df9a6c8adbf66e5986d9df74 100644 (file)
@@ -36,3 +36,7 @@ src_trunnel_libor_trunnel_testing_a_CPPFLAGS = -DTRUNNEL_LOCAL_H $(AM_CPPFLAGS)
 src_trunnel_libor_trunnel_testing_a_CFLAGS = $(AM_CFLAGS) $(TEST_CFLAGS)
 
 noinst_HEADERS+= $(TRUNNELHEADERS)
+
+EXTRA_DIST += \
+       src/trunnel/README
+