浏览代码

readme as markdown

Sven Sickert 8 年之前
父节点
当前提交
559f470deb
共有 1 个文件被更改,包括 17 次插入22 次删除
  1. 17 22
      README.md

+ 17 - 22
README → README.md

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