From b55fb89ae5cb5cef8bb5a89e9a088df1aa2ad0b4 Mon Sep 17 00:00:00 2001
From: Andrej Babic <andrej.babic@psi.ch>
Date: Thu, 23 Jul 2020 13:06:13 +0200
Subject: [PATCH] Add stub README files for components

---
 sf-stream/README.md |  1 +
 sf-utils/README.md  |  1 +
 sf-writer/README.md | 39 +++++++++++++++++++++++++++++++++++++++
 3 files changed, 41 insertions(+)
 create mode 100644 sf-stream/README.md
 create mode 100644 sf-utils/README.md
 create mode 100644 sf-writer/README.md

diff --git a/sf-stream/README.md b/sf-stream/README.md
new file mode 100644
index 0000000..fd88986
--- /dev/null
+++ b/sf-stream/README.md
@@ -0,0 +1 @@
+# sf-stream
\ No newline at end of file
diff --git a/sf-utils/README.md b/sf-utils/README.md
new file mode 100644
index 0000000..87e0185
--- /dev/null
+++ b/sf-utils/README.md
@@ -0,0 +1 @@
+# sf-utils
\ No newline at end of file
diff --git a/sf-writer/README.md b/sf-writer/README.md
new file mode 100644
index 0000000..1300b11
--- /dev/null
+++ b/sf-writer/README.md
@@ -0,0 +1,39 @@
+# sf-writer
+
+## Data request ranges
+
+Data request ranges are composed of:
+
+- start_pulse_id (first pulse_id to be included in the file)
+- stop_pulse_id (last pulse_id to be included in the file)
+- pulse_id_step (how many pulses to skip between images.)
+
+pulse_id_step can be used to write data at different frequencies:
+
+- pulse_id_step == 1 (100Hz, write very pulse_id)
+- pulse_id_step == 2 (50hz, write every second pulse)
+- pulse_id_step == 10 (10Hz, write every 10th pulse)
+
+The next pulse_id to be written is calculated internally as:
+
+```c++
+auto next_pulse_id = currnet_pulse_id + pulse_id_step;
+```
+
+The loop criteria for writing is:
+
+```c++
+for (
+        auto curr_pulse_id = start_pulse_id; 
+        curr_pulse_id <= stop_pulse_id;
+        curr_pulse_id += pulse_id_step
+) {
+    // Write curr_pulse_id to output file.
+}
+```
+
+**Warning**
+
+If your stop_pulse_id cannot be reached by adding step_pulse_id to 
+start_pulse_id (start_pulse_id + (n * pulse_id_step) != stop_pulse_id for any n)
+it will not be included in the final file.
\ No newline at end of file