1 files changed, 23 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..596f8fe
--- /dev/null
+++ b/README
@@ -0,0 +1,23 @@
+PTP Clock reflector
+===================
+
+Reflector takes packets from a PTP (IEEE1588:2008) clock running on PTP domain
+0, and makes it available on PTP domain 1 and also changes the clock
+identification accordingly.
+
+This allows making a local clock available on the network and reflecting it
+back to the same machine for testing of PTP clock implementations.
+
+Locally you can run ptpd from http://ptpd.sourceforge.net with
+  ptpd -i eth0 -M -n -C
+and a PTP slave clock, e.g.
+  http://cgit.freedesktop.org/~slomo/gstreamer/tree/tests/examples/ptp/ptp-print-times.c?h=ptp
+  ./ptp-print-times -d 1
+
+Remotely you can run reflector with
+  ./reflector
+
+The PTP slave clock will now get the local clock time from the network with 2
+round-trip times between the local and remote machine added. If the PTP slave
+clock implementation works correct, the difference between the local clock and
+the "remote" PTP clock should be approximately 0.