aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDeterminant <ted.sybil@gmail.com>2014-11-05 06:32:51 +0800
committerDeterminant <ted.sybil@gmail.com>2014-11-05 06:32:51 +0800
commit06be40b2f79e9d5ebcdf6527a04fcf36cc2fb4ab (patch)
tree699abc8a3ad7333484be1a2845c9c65335969bf5
parent437501226f7ff9974c882977e62d704a561f8979 (diff)
add dependency section in the readme
-rw-r--r--README.rst14
-rw-r--r--mpd_trigger.c2
2 files changed, 12 insertions, 4 deletions
diff --git a/README.rst b/README.rst
index ebfd514..5f00782 100644
--- a/README.rst
+++ b/README.rst
@@ -25,8 +25,8 @@ little overhead.
How to Use?
-----------
First, compile it by invoking ``make``. The only executable file is
-``mpd_trigger``. You could run ``./mpd_trigger -h`` to read the help. A typical
-example is as follow (execute in bash):
+``mpd_trigger``. You could run ``./mpd_trigger -h`` to read the help
+information. A typical example is as follow (executed in bash):
::
@@ -37,7 +37,7 @@ executing that ``echo`` command.
You may have noticed something like ``{title}`` which is actually a pattern
representing the title of the song is to be filed in that place.
-``mpd_trigger`` currently support two kinds of patterns:
+``mpd_trigger`` currently supports two kinds of patterns:
- Information patterns: ``{title}``, ``{artist}``, ``{album}``, ``{track}``,
``{state}``, ``{elapsed_time}``, ``total_time``, ``{elapsed_pct}``
@@ -60,3 +60,11 @@ of the pattern in last example ``{track?{track}:unkown track}`` makes use of
such technique. Have fun! :)
.. _mpd-hiss: https://github.com/ahihi/mpd-hiss
+
+Dependencies
+------------
+
+- The canonical mpd library: libmpdclient (on which famous mpd clients such as
+ mpc and ncmpcppp also depends)
+- Some basic POSIX syscalls (ubiquitous on current unix-like systems)
+- Nothing else.
diff --git a/mpd_trigger.c b/mpd_trigger.c
index 9a5080c..6e13b79 100644
--- a/mpd_trigger.c
+++ b/mpd_trigger.c
@@ -21,9 +21,9 @@
#include <unistd.h>
#include <string.h>
#include <stdlib.h>
+#include <getopt.h>
#include <sys/wait.h>
#include <sys/types.h>
-#include <getopt.h>
#include <mpd/idle.h>
#include <mpd/tag.h>