diff --git a/README.md b/README.md index e30ff14..60bb55b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ # sanipy +sanipy is a command-line tool for epics connection testing. + +It has two commands ([check](check) and [compare](compare)) and a few option switches (check `sani.py -h` and `sani.py COMMAND -h`). + +The `data` folder contains some channel lists and output files for testing. + +## check + +`./sani.py check data/test_chans_good.txt` + + +`./sani.py check data/test_chans_bad.txt` + + + +## compare + +`./sani.py compare data/test1.csv data/test4 -v` + + +`./sani.py compare data/test1.csv data/test3` + + +(Note here that `.csv` is automatically appended if missing.)