summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2015-02-10 14:50:58 +0100
committerMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2015-02-10 14:51:48 +0100
commiteaf8eb26a4f9f017241897a8b8d33774827c6641 (patch)
tree389e5a98adcb35503071e4f0dcffd17cd20c0d73 /README.md
parente34b5eaa7603d659b794c430359e64b45d791606 (diff)
downloadufodecode-eaf8eb26a4f9f017241897a8b8d33774827c6641.tar.gz
ufodecode-eaf8eb26a4f9f017241897a8b8d33774827c6641.tar.bz2
ufodecode-eaf8eb26a4f9f017241897a8b8d33774827c6641.tar.xz
ufodecode-eaf8eb26a4f9f017241897a8b8d33774827c6641.zip
Markdownify README file
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..43050ee
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+## 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.