Add per-directory synopsis.

diff --git a/cli/README.markdown b/cli/README.markdown
new file mode 100644 (file)
index 0000000..5f6ed1b
--- /dev/null
+++ b/cli/README.markdown
@@ -0,0 +1 @@
+Implementation of the `apitrace` command line interface.

diff --git a/dispatch/README.markdown b/dispatch/README.markdown
new file mode 100644 (file)
index 0000000..d041f7d
--- /dev/null
+++ b/dispatch/README.markdown
@@ -0,0 +1,9 @@
+The dispatch layer objecting is to get public or private symbols from DLLs /
+shared objects and dispatch calls to them.
+
+It used both by the tracing wrappers (to dispatch the intercepted calls to
+their true counterparts) and when replaying traces (to dispatch the calls
+recorded on the file)
+
+All code is generated from dispatch.py Python script, which is then used in
+several places.

diff --git a/gui/README.markdown b/gui/README.markdown
new file mode 100644 (file)
index 0000000..9872fef
--- /dev/null
+++ b/gui/README.markdown
@@ -0,0 +1 @@
+Implementation of the `qapitrace` Qt-based GUI for apitrace.

diff --git a/helpers/README.markdown b/helpers/README.markdown
new file mode 100644 (file)
index 0000000..2f30baa
--- /dev/null
+++ b/helpers/README.markdown
@@ -0,0 +1,5 @@
+This directory contains several headers with inline functions that are referred
+in the specs for determining array/sizes.
+
+These are used both when tracing and replaying so care must be taken not to
+make any assumptions.

diff --git a/image/README.markdown b/image/README.markdown
new file mode 100644 (file)
index 0000000..9236a8f
--- /dev/null
+++ b/image/README.markdown
@@ -0,0 +1,2 @@
+This directory contains class to represent and manipulate images, in memory or
+disk.

diff --git a/inject/README.markdown b/inject/README.markdown
new file mode 100644 (file)
index 0000000..df56b1a
--- /dev/null
+++ b/inject/README.markdown
@@ -0,0 +1,5 @@
+Utilities for injection of DLLs in Windows.
+
+Wrapper DLLs work well for self-contained APIs (e.g., OpenGL with its
+opengl32.dll), but not for APIs which are spread across multiple DLLs, in
+particular DXGI and D3D10+ APIs.

diff --git a/retrace/README.markdown b/retrace/README.markdown
new file mode 100644 (file)
index 0000000..74ecfe0
--- /dev/null
+++ b/retrace/README.markdown
@@ -0,0 +1,9 @@
+The source for replaying retraces lives in this directory.
+
+There are actually several discting layers in this directory which should be eventually be split out:
+
+ - `*`retrace -- deserialization and interpretation of calls from a trace
+
+ - `*`ws -- windowing system helpers and abstractions
+
+ - `*`state -- dumping of state into JSON format

diff --git a/specs/README.markdown b/specs/README.markdown
new file mode 100644 (file)
index 0000000..b82672c
--- /dev/null
+++ b/specs/README.markdown
@@ -0,0 +1,7 @@
+This directory contains specification of several APIs in a Python class
+hierarchy.
+
+The base classes of this hierarchy are in stdapi.py.
+
+Some of this specifications are (partially) generated from other external
+specifications, by scripts in the scripts subdirectory.

diff --git a/wrappers/README.markdown b/wrappers/README.markdown
new file mode 100644 (file)
index 0000000..2c7b662
--- /dev/null
+++ b/wrappers/README.markdown
@@ -0,0 +1,5 @@
+This directory contains the source for the generation of wrapper DLLs or
+preload shared-objects.
+
+The cmake targets have names different from the true DLLs/shared-objects to
+prevent collision when trying to link against the true ones.