summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2015-07-14 20:10:53 +0200
committerGravatar Christian Hesse <mail@eworm.de>2015-07-14 20:10:53 +0200
commit8003e636f6cc178f9e901fca5fa0c8abb4ffe293 (patch)
tree05ffd01f260807bf17743af86c4e234822dd3c34
parentc937af44c912773aa3e8fd9ed88045e483cb9956 (diff)
downloadextract-artwork-0.0.1.tar.gz
extract-artwork-0.0.1.tar.zst
basic documentation0.0.1
-rw-r--r--README.md38
1 files changed, 37 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7b5e417..5e30770 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,40 @@
extract-artwork
===============
-Extract artwork from media files
+**Extract artwork from media files**
+
+Takes a number of media files and extracts artwork images.
+
+Requirements
+------------
+
+To compile and run `extract-artwork` you need:
+
+* [libav](https://libav.org/) or [ffmpeg](https://www.ffmpeg.org/)
+* [markdown](http://daringfireball.net/projects/markdown/) (HTML documentation)
+
+Some systems may require additional development packages for the libraries.
+
+Build and install
+-----------------
+
+Building and installing is very easy. Just run:
+
+> make
+
+followed by:
+
+> make install
+
+This will place an executable at `/usr/bin/extract-artwork`,
+documentation can be found in `/usr/share/doc/extract-artwork/`.
+
+Usage
+-----
+
+Just run `extract-artwork` and add argument with media file names.
+
+### Upstream
+
+URL: [GitHub.com](https://github.com/eworm-de/extract-artwork)
+Mirror: [eworm.de](http://git.eworm.de/cgit.cgi/extract-artwork/)