aboutsummaryrefslogtreecommitdiff
path: root/src/app/app.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/app/app.md')
-rw-r--r--src/app/app.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/app/app.md b/src/app/app.md
new file mode 100644
index 0000000000..298bde75f5
--- /dev/null
+++ b/src/app/app.md
@@ -0,0 +1,11 @@
+@dir /app
+@brief app: top-level entry point for Tor
+
+The "app" directory has Tor's main entry point and configuration logic,
+and is responsible for initializing and managing the other modules in
+Tor.
+
+The modules in "app" are:
+
+ - \refdir{app/config} -- configuration and state for Tor
+ - \refdir{app/main} -- Top-level functions to invoke the rest or Tor.