Talk about the config file

mineo · May 20, 2016 · 51949a8 · 51949a8
1 parent 42bd07f
commit 51949a8
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/README.org b/README.org
@@ -1,4 +1,5 @@
 #+OPTIONS: toc:nil html-postamble:nil num:nil author:nil
+
 * abzer
 
 Install abzer as shown [[https://abzer.readthedocs.org/en/latest/setup.html][here]] , run it by either calling =/usr/bin/abzer= or
@@ -22,3 +23,8 @@ optional arguments:
                         (default: <number of cpus>)
   -v, --verbose         Be more verbose. (default: False)
 #+END_EXAMPLE
+
+abzer uses the same config file as the [[https://github.com/MTG/acousticbrainz-client][acousticbrainz-client]] application, but
+only uses the =path= option in the =essentia= section. However, it doesn't require a
+config file to work, but just uses default values. If those don't work on your
+system, you'll be notified of that.
diff --git a/README.txt b/README.txt
@@ -1,3 +1,6 @@
+
+
+
 abzer
 ═════
 
@@ -23,5 +26,13 @@ abzer
   │   -v, --verbose         Be more verbose. (default: False)
   └────
 
+  abzer uses the same config file as the [acousticbrainz-client]
+  application, but only uses the `path' option in the `essentia'
+  section. However, it doesn't require a config file to work, but just
+  uses default values. If those don't work on your system, you'll be
+  notified of that.
+
 
   [here] https://abzer.readthedocs.org/en/latest/setup.html
+
+  [acousticbrainz-client] https://github.com/MTG/acousticbrainz-client