Add INSTALL and README

4 files changed, 77 insertions, 1 deletions

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 94a80a1..2d67804 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -8,9 +8,13 @@ set(LIBUFODECODE_ABI_MAJOR_VERSION "0")
 set(PACKAGE_VERSION "0.2.0")
 set(PACKAGE_NAME "${TARNAME}")
 set(PACKAGE_TARNAME "${TARNAME}")
-set(PACKAGE_STRING "${PACKAGE_NAME} ${PACKAGE_VERSION}")
+set(PACKAGE_STRING "${PACKAGE_NAME}-${PACKAGE_VERSION}")
 set(PACKAGE_BUGREPORT "http://ufo.kit.edu/ufo/newticket")
 
+set(CPACK_SOURCE_GENERATOR "TGZ")
+set(CPACK_SOURCE_IGNORE_FILES ".git" "tags" ".bzr" ".swp")
+set(CPACK_SOURCE_PACKAGE_FILE_NAME ${PACKAGE_STRING} CACHE INTERNAL "tarball basename")
+
 if(NOT DEFINED BIN_INSTALL_DIR)
     set(BIN_INSTALL_DIR "${CMAKE_INSTALL_PREFIX}/bin")
 endif(NOT DEFINED BIN_INSTALL_DIR)
@@ -36,3 +40,4 @@ add_subdirectory(src)
 add_subdirectory(doc)
 add_subdirectory(test)
 
+include(CPack)
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..128277f
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,45 @@
+Simple install procedure
+========================
+
+  $ tar xfz libufodecode-0.x.y.tar.xfz
+  $ cd libufodecode-0.x.y
+  $ mkdir build
+  $ cd build/
+  $ cmake ..
+  $ make
+
+  [ Become root if necessary ]
+  $ make install
+
+
+Requirements
+============
+
+libuca requires CMake and a standard C Compiler. Information about CMake can be
+found at:
+
+    http://www.cmake.org
+
+
+Building the Library
+====================
+
+On Linux, libufodecode uses the CMake build system. The normal procedure to
+build this library is to create an empty build directory:
+
+    $ mkdir build/ && cd build
+
+configure the project using CMake:
+
+    $ cmake ../
+
+and compiling the library with make:
+
+    $ make
+    $ make install
+
+Options to the build process can be passed to the system when configuring:
+
+    $ cmake ../ -DCMAKE_INSTALL_PREFIX=/usr
+
+or via configuration tools like `ccmake`.
diff --git a/README b/README
new file mode 100644
index 0000000..2030153
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+
+General Information
+===================
+
+This directory contains libufodecode version 0.6. This package provides a
+library to decode frames from the UFO camera developed at IPE/KIT. It is able to
+decode frames produced with firmware versions 4, 5 and 5 with 12-bit support.
+The library is a dependency of pcilib to decode frames on-the-fly.
+
+This package also contains a stand-alone offline decoder called `ipedec` to
+decode raw frames acquired with the `pcitool` program. More information is
+available by calling
+
+  $ ipedec -h
+
+Installation
+============
+
+Please see the file called INSTALL.
+
+
+Licensing
+=========
+
+Please see the file called COPYING.
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 8fca838..313b932 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -52,5 +52,6 @@ install(FILES
 if ("${CMAKE_BUILD_TYPE}" MATCHES "Debug")
     set(DEBUG "1")
 endif()
+
 configure_file(config.h.in ${CMAKE_CURRENT_BINARY_DIR}/config.h)