doc

bmarechal
1 parent 630b7a7af1
Showing 2 changed files with 21 additions and 0 deletions Side-by-side Diff
README.md
doc/datalogger-gui.png
@@ -3,4 +3,25 @@
 A GUI interfaced software to log multiple instruments via ethernet, usb or serial connection.
  
 `./datalogger-gui.py`
+
+![screenshot](doc/datalogger-gui.png)
+
+## Usage
+
+- Select the instrument to log
+- Check the IP/serial/usb address
+- enter a sample time (default = 1)
+- select a channel
+- precise the type
+- press start
+
+## Saving Tree
+
+Each daily file is saved in a tree as following:
+```
+current folder
+└── YYYY
+	└── YYYY-MM
+	    └── YYYYMMDD-hhmmss-instrument.dat
+```
...	...	@@ -3,4 +3,25 @@
3	3	A GUI interfaced software to log multiple instruments via ethernet, usb or serial connection.
4	4
5	5	`./datalogger-gui.py`
	6	+
	7	+![screenshot](doc/datalogger-gui.png)
	8	+
	9	+## Usage
	10	+
	11	+- Select the instrument to log
	12	+- Check the IP/serial/usb address
	13	+- enter a sample time (default = 1)
	14	+- select a channel
	15	+- precise the type
	16	+- press start
	17	+
	18	+## Saving Tree
	19	+
	20	+Each daily file is saved in a tree as following:
	21	+```
	22	+current folder
	23	+└── YYYY
	24	+ └── YYYY-MM
	25	+ └── YYYYMMDD-hhmmss-instrument.dat
	26	+```