Add INSTALL.md

Clement Champetier · Clement Champetier · commit 4ed76853ede9 · 2015-03-02T17:35:58.000+01:00
diff --git a/INSTALL.md b/INSTALL.md
@@ -0,0 +1,42 @@
+# Compilation
+
+AvTranscoder uses CMake as build system.
+
+#### To build
+```
+mkdir build && cd build
+cmake ..
+make
+make install
+```
+
+#### To indicate a specific ffmpeg/libav folder
+```
+cmake .. -DFFMPEG_INCLUDE_DIR=/path/to/include/ -DFFMPEG_LIBRARY_DIR=/path/to/lib/
+```
+
+#### To not build apps
+```
+cmake .. -DDISABLE_APPS=True
+```
+
+#### To not build bindings
+```
+cmake .. -DDISABLE_BINDINGS=True
+```
+```
+cmake .. -DDISABLE_PYTHON_BINDING=True
+```
+```
+cmake .. -DDISABLE_JAVA_BINDING=True
+```
+
+#### Other useful flags
+###### To install at a specific location
+```
+cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/install
+```
+###### To build Release/Debug version
+```
+cmake .. -DCMAKE_BUILD_TYPE=Release/Debug
+```
diff --git a/README.md b/README.md
@@ -13,6 +13,9 @@ Based on Libav/FFmpeg libraries to support various video and audio formats, avTr
 #### License
 See [**COPYING.md**](COPYING.md)
 
+#### Compilation
+See [**INSTALL.md**](INSTALL.md)
+
 #### How to use
 Check out applications contained in the project to see examples of how to use the library in C++, Java or Python.
 
