1 files changed, 42 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..0911794
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,42 @@
+################################################################################
+##                                                                            ##
+##             Compiling and installing pdfPresentation on Linux.             ##
+##                                                                            ##
+################################################################################
+
+* Requirements:
+    Qt 4.x
+    poppler-qt4
+
+* Compiling:
+  Run
+    make
+  
+  The default paths can be modified by passing the appropriate arguments to
+  make, as specified in the following table
+    qmake-qt4  :  QMAKE=/usr/bin/qmake-qt4
+    GNU make   :  MAKE=/usr/bin/make
+    include    :  INCLUDE=/usr/include
+    lib paths  :  LIB=-L/usr/libs
+
+  For example, if poppler is installed in /usr/local and qmake is located at
+  /usr/local/bin/qmake-qt4.8, then run
+    make QMAKE=/usr/local/bin/qmake-qt4.8 INCLUDE=/usr/local/include LIBS=-L/usr/local/libs
+
+
+* Installing:
+  Run
+    make install
+
+  The default install prefix (/usr) can be changed by changing the PREFIX
+  variable.
+
+  For example
+    make install PREFIX=/usr/local
+
+
+* Comments on portability:
+  Since pdfPresentation is written using the Qt toolchain, it should be easy to
+  port it to other platforms that support Qt and poppler, though this has not
+  been tested.
+