From 1d75808c0e51c61f32fe8f010d87c5087168fdbb Mon Sep 17 00:00:00 2001
From: boyska <piuttosto@logorroici.org>
Date: Thu, 5 Jan 2017 14:00:14 +0100
Subject: [PATCH] readme

---
 CMakeLists.txt |  2 ++
 README.md      | 26 ++++++++++++++++++++++++++
 2 files changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 1fc4e68..d7abc39 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -13,6 +13,8 @@ if (CUDA_FOUND)
     include( FindCUDA )
     cuda_add_executable( bs_dsp bs_dsp.cu )
     target_link_libraries( bs_dsp ${OpenCV_LIBS} )
+else()
+    message(STATUS "CUDA not found; will skip bs_dsp")
 endif (CUDA_FOUND)
 
 add_executable( lines lines.cpp )
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..37f830f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+Misc tools to identify important points/lines of book photos.
+
+Build howto
+============
+
+```sh
+cmake && make
+./getfiles
+```
+(getfiles will sync the `files/` directory from a remote server; no big files on git!)
+
+Please note that bs_dsp requires CUDA libraries to be built (and an NVidia card to be run). If you don't have
+the appropriate libraries, it will just be skipped.
+
+Tools
+=======
+
+bs_dsp
+---------
+
+correct colors, contrast, etc
+
+lines
+-------
+
+Given an image like `files/masckera.png` it will extract the shape of the book