From 2cbeae72bd847e95c6e77bf5e5e53735baf798e7 Mon Sep 17 00:00:00 2001
From: Sven Augustin <sven.augustin@psi.ch>
Date: Tue, 22 Feb 2022 20:36:17 +0100
Subject: [PATCH] added readme

---
 procprof/README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 procprof/README.md

diff --git a/procprof/README.md b/procprof/README.md
new file mode 100644
index 0000000..06b2c60
--- /dev/null
+++ b/procprof/README.md
@@ -0,0 +1,23 @@
+# Processing Profiler
+
+## Preparation
+
+Extract some camera images and dump them:
+
+```bash
+./make_example_images.py -i /some/measured_data.CAMERAS.h5 -c SOME-CAMERA
+```
+
+## Profiling
+
+Profile a processing script using the example images:
+
+```bash
+./procprof.py a_processing_script.py example_images.npy
+```
+
+Profiling output files are written to `./prof/`.
+
+Check `-h` on both scripts for more options. 
+
+