add trinketSetAlarmLevel
[trinked.git] / README.md
index 2ca64bd..20a2e5b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,20 +3,21 @@ name/brand: Брелок Гейгера.
 
 The tool was developed for FreeBSD but it should be very easy to port it on
 Linux.
+Prerequisites: libhidapi (FreeBSD ports: comms/hidapi,
+                          http://www.signal11.us/oss/hidapi/)
 
 trinketd [-d] [-p pidfile] [-P period] [-D datadir] [-i tics] [-l logfile]
-
--i d        - daemonize
+-d          - daemonize
 -p pidfile  - create a pid-file
 -P period   - collection period, in seconds, default 300 secs
 -D datadir  - directory to place output file, default stdout
 -i tics     - the number of samples for the moving average, default 1
--l logfile  - name of log file, if absent will send to syslog if daemonize else
-              stderr
+-l logfile  - name of log file, if it's not presented then messages will send
+              to syslog if daemonize else stderr
 
 Format of data file:
-total: 7220       - total number of Geiger event's (since power on) 
-counts: 167       - number of Geiger event's for tics * period time 
+total: 7220       - total number of Geiger's events (since power on) 
+counts: 167       - number of Geiger's events for tics * period time 
 tics: 12          - number of samples 
 radlevel: 15.71   - radiation level, mkR/h