From: Teodor Sigaev <teodor@sigaev.ru>
Date: Fri, 15 Apr 2016 12:44:27 +0000 (+0300)
Subject: add README
X-Git-Url: http://sigaev.ru/git/gitweb.cgi?p=trinked.git;a=commitdiff_plain;h=d7d637b1e3ffb55378c66a4f35fb45e847ba5d27

add README
---

diff --git a/Makefile b/Makefile
index 78e3db9..21e7968 100644
--- a/Makefile
+++ b/Makefile
@@ -31,4 +31,6 @@ clean:
 
 install: all
 	$(INSTALL) trinketd /usr/local/sbin/trinketd
-	$(INSTALL) rc.d/trinketd /usr/local/etc/rc.d/trinketd 
+	$(INSTALL) rc.d/trinketd /usr/local/etc/rc.d/trinketd
+	[ -d /var/db/trinket ] || mkdir -p /var/db/trinket
+	[ -f /var/log/trinketd.log ] || touch /var/log/trinketd.log
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5827b31
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+Trinketd - driver and collecting tool for Atom Pro/Atom mini 2.
+
+The tool was developed for FreeBSD but it should be very easy to port it on
+Linux.
+
+trinketd [-d] [-p pidfile] [-P period] [-D datadir] [-i tics] [-l logfile]
+
+-i 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
+
+Copyright (c) 2016, Teodor Sigaev <teodor@sigaev.ru>
diff --git a/main.c b/main.c
index 6bbd6cf..f283be0 100644
--- a/main.c
+++ b/main.c
@@ -53,7 +53,7 @@ static void
 usage(const char *errmsg) {
 	puts("trinketd - collecting info from AtomPro");
 	puts("Copyright (c) 2016, Teodor Sigaev <teodor@sigaev.ru>");
-	puts("trinketd [-d] [-p pidfile] [-P period] [-D datadir] [-i tics]");
+	puts("trinketd [-d] [-p pidfile] [-P period] [-D datadir] [-i tics] [-l logfile");
 
 	if (errmsg) {
 		puts("");