1.0 -> 1.1

readme.md

@@ -1,15 +1,25 @@
-# TENG scripts
+# K-TENG
-Helper scripts for measuring TENG-based sensor output from a Keithley 2611B using pyvisa in a jupyter notebook
+Helper scripts for measuring **T**ribo**e**lectric **N**ano**g**enerator-based sensor output with a Keithley 2611B SMU using pyvisa
-## Requirements
+
+## Features
+### Useful functions for scripts
 - Measure Voltage
 - Measure Voltage and Current
 - Save to host
+- run lua script
+- auto-filenames
+### Interactive (shell) mode
 - Live view
-- autofilenames
 - press buttons for start and fin
 - settings:
     - interval
     - count
-- run arbitrary command
+- easily run arbitrary command on device
-- run lua script
 
+## Shell mode
+Start with:
+```python
+ipython -i k_teng_interactive.py
+```
+
+Use `help()` to get a list of available commands