From 14b5f36a729416bdc43e861df2379a3b8189484b Mon Sep 17 00:00:00 2001 From: Joao Carreira Date: Sun, 26 Jan 2014 15:40:46 +0000 Subject: [PATCH] Create proper README file --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b598f08..cda0e57 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,30 @@ -playuver +plaYUVer ======== plaYUVer is an open-source raw video player + + +Usage +---------------------------------------------------------------- + +Command line interface +./playuver -i [Input File] -w [Width] -h [Height] + + +Install using cmake +---------------------------------------------------------------- + +The following are required for compilation: +- an ordinary C++ development environment (g++, make, C++ libraries and headers, ...) +- cmake +- a Qt development environment (libraries, headers, qmake, ...): only QtCore, QtGui and QtWidgets are required, at least in version 4 + +Dependencies: +- QT +- OpenCv (optional) + +Run the following commands: (this will create an executable named playuver) + mkdir build + cd build + cmake ../ + make \ No newline at end of file