X-Git-Url: http://www.average.org/gitweb/?p=pulsecounter.git;a=blobdiff_plain;f=linux%2FREADME.md;fp=linux%2FREADME.md;h=81ed199892173f62010f63d8070d3750b6bdd440;hp=0000000000000000000000000000000000000000;hb=2560f6675b87b67d488a9fb6b07dc2e075447e95;hpb=f6a4965a22830a74cfbcc9b0b549d71d976bf5cb

diff --git a/linux/README.md b/linux/README.md
new file mode 100644
index 0000000..81ed199
--- /dev/null
+++ b/linux/README.md
@@ -0,0 +1,27 @@
+= Host side of the pulse counter infrastructure. =
+
+pulsecounter.c is modelled after BlueZ' gatttool. Because of "strange"
+design of BlueZ tools, it is not sufficient to use the library that
+gets installes with it. Complete source installation is necessary.
+
+So, unpack, configure *and build* BlueZ source (do not `make install`).
+In this directory, run `make BLUEZ=/path/to/top/of/bluez/source`. You
+will get the `pulsecounter` binary.
+
+Currently (2015-12-21) supplied database adapter uses MySQL(/MariaDB).
+Confiruration file (default path `/etc/pulsecounter.db`) contains lines
+of this format:
+
+    key SPACE* [=:]* SPACE* value
+
+Lines are analyzed up to the '#' character (comment separator).
+There is no escaping.
+
+Keys are:
+
+    host	hostname, NULL if not specified (meaning local database).
+    user	database user name, NULL if not specified
+    password	database password, NULL if not specified
+    database	database name, "watermeter" if not specified.
+
+