summaryrefslogtreecommitdiff
path: root/src/trunnel
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2015-09-29 13:43:12 +0200
committerNick Mathewson <nickm@torproject.org>2015-09-29 13:43:12 +0200
commit62d6a8ef4db8b720bfb2786775fdf617dc8351be (patch)
tree13c45059e6d82c42fefaf11c1f8f54715b465b8a /src/trunnel
parentaaf748435cb6e42922bf5948b04b4679bbf649b1 (diff)
downloadtor-62d6a8ef4db8b720bfb2786775fdf617dc8351be.tar.gz
tor-62d6a8ef4db8b720bfb2786775fdf617dc8351be.zip
Add a README for the trunnel directory
Diffstat (limited to 'src/trunnel')
-rw-r--r--src/trunnel/README10
-rw-r--r--src/trunnel/include.am4
2 files changed, 14 insertions, 0 deletions
diff --git a/src/trunnel/README b/src/trunnel/README
new file mode 100644
index 0000000000..383272cf78
--- /dev/null
+++ b/src/trunnel/README
@@ -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
diff --git a/src/trunnel/include.am b/src/trunnel/include.am
index 9bf37fe58b..b1448b7cb2 100644
--- a/src/trunnel/include.am
+++ b/src/trunnel/include.am
@@ -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
+