Add the ability to continue backwards

[timetravel.git] / README.md

diff --git a/README.md b/README.md
index 1d53a51a5b4441c6425bf855e2e0c2cbe897743d..7c70a86f0efd71df11ce20cc0003ff852920d99a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,17 @@
-# Time Travelling Debugger
+# ttdb: Time Travelling Debugger
+
+Designed to be similar to lldb.
+
+It works by splitting up debugging into two parts:
+1. Tracing the execution of the program with `Tracer`
+2. Stepping through the traced steps
+
+By tracing the execution first, the control flow can happen in pure Haskell land
+without getting its hands dirty in IO. 
+It also has the funny effect of allowing you to see what will be evaluated
+next before the side effects are shown.
+
+## Features
+- Parses infix expressions like '3 + x' (Sub expressions require brackets)
+- Evaluate expressions when paused
+- Continue to the next breakpoint - both forwards and backwards