瀏覽代碼

added short readme file

Sven Sickert 8 年之前
父節點
當前提交
71ae42fc80
共有 1 個文件被更改,包括 56 次插入0 次删除
  1. 56 0
      README

+ 56 - 0
README

@@ -0,0 +1,56 @@
+ImageLabeler
+============
+by Computer Vision Group Jena, 2012-2016
+
+
+1 Description
+#############
+
+ImageLabeler is a small GUI-based labeling tool for annotating images for semantic segmentation,
+object detection and tagging purposes.
+
+
+2 Installation
+##############
+
+In order to install the program follow the usual steps when compiling using CMake. For systems
+using Linux that is:
+
+  (1) Navigate to your ImageLabeler directory and create a building sub-directory
+
+  #> cd /path/to/imagelabeler/
+  #> mkdir build
+  #> cd build
+
+  (2) Configure your installation using CMake
+
+  #> ccmake ..
+
+  (3) Compile and install the program
+
+  #> make
+  #> make install
+
+Depending on your installation settings (i.e. install path) you should now be able to start
+the program from the command line using either
+
+  #> ImageLabeler
+
+or alternatively from inside the build directory using
+
+  #> ./ImageLabeler
+
+
+3 Usage
+#######
+
+Please, refer for instructions regarding the usage of the program to the files provided in the
+"man" sub-directory (formatted as HTML, PDF and ODT)
+
+
+4 Contributors
+##############
+
+Gapchich Vladislav
+Johannes Rühle
+Sven Sickert