Browse Source

Add a README for the trunnel directory

Nick Mathewson 8 years ago
parent
commit
62d6a8ef4d
2 changed files with 14 additions and 0 deletions
  1. 10 0
      src/trunnel/README
  2. 4 0
      src/trunnel/include.am

+ 10 - 0
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

+ 4 - 0
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
+