From: Antonio Ospite <ospite@studenti.unina.it>
Date: Tue, 15 May 2012 08:35:05 +0000 (+0200)
Subject: HACKING.asciidoc: add info about getting and building libam7xxx
X-Git-Tag: v0.1.3~31
X-Git-Url: https://git.ao2.it/libam7xxx.git/commitdiff_plain/944aa0cf862aa4cf6573c5259a19be6144c27514

HACKING.asciidoc: add info about getting and building libam7xxx

Some Ubuntu user asked for a step by step guide.
---

diff --git a/HACKING.asciidoc b/HACKING.asciidoc
index ed2a46b..ff5c62b 100644
--- a/HACKING.asciidoc
+++ b/HACKING.asciidoc
@@ -5,6 +5,31 @@
 libam7xxx uses the linux kernel coding style:
 http://kernel.org/doc/Documentation/CodingStyle
 
+=== Getting and compiling libam7xxx
+
+libam7xxx depends on 'libusb-1.0' and optionally on 'libav' or 'ffmpeg' for
+its example programs, the build system used is 'cmake'.
+
+On a Debian based system, the dependencies can be installed with this command:
+
+  $ sudo aptitude install cmake \
+                          libusb-1.0-0-dev \
+                          libavformat-dev \
+                          libavcodec-dev \
+                          libavdevice-dev \
+                          libswscale-dev
+
+The library and the example programs can be compiled following these steps:
+
+  $ git clone git://git.ao2.it/libam7xxx.git
+  $ cd libam7xxx
+  $ mkdir build
+  $ cd build
+  $ cmake ../
+  $ make
+
+After that the example programs can be found in the +bin/+ subdirectory.
+
 === Debug builds
 
 The suggested way to hack on the project is: