Add README

2 files changed, 17 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fdb54e4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# kaxxxxp-viewer - Data Logger and Viewer for KAxxxxP power supplies
+
+**kaxxxxp-viewer** acquires and visualizes voltage and current data from
+KAxxxxP power supplies. These PSUs are equipped with a USB port, which can
+be used both for remote control and data acquisition using a serial protocol.
+
+See `bin/kaxxxxp-viewer --help` for usage details.
+
+## Dependencies
+
+* Python 3 with the following modules: numpy, serial
+* Data Visualization (--plot): python3-matplotlib
diff --git a/bin/kaxxxxp-viewer b/bin/kaxxxxp-viewer
index afceb57..9ff5ca5 100755
--- a/bin/kaxxxxp-viewer
+++ b/bin/kaxxxxp-viewer
@@ -184,6 +184,11 @@ def measure_data(port, filename, duration):
     else:
         output_handle = tempfile.TemporaryFile("w+")
 
+    if duration:
+        print(f"Logging data for {duration} seconds. Press Ctrl+C to stop early.")
+    else:
+        print(f"Starting data acquisition. Press Ctrl+C to stop.")
+
     print("# Device: " + korad.connect(), file=output_handle)
     print("# Timestamp Voltage Current", file=output_handle)
     while not terminate_measurement: