1 files changed, 16 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..3a6a81d
--- /dev/null
+++ b/README
@@ -0,0 +1,16 @@
+Build with:
+
+	make
+
+Run tests and display performance plots with:
+
+	make tests
+
+Run the 'show' target to show all the steps with an example ruleset and
+packet list, e.g.:
+
+	./pipapo.show tests/net_port_ranged.tiny tests/net_port_ranged.tiny.packets
+
+Run the main target for a quick performance test against a ruleset, e.g.:
+
+	./pipapo tests/net_port.static tests/net_port.static.packets