Merge branch '66-readme-to-md' into 'master'

Update ReadMe.md

See merge request !45

ReadMe.txt → ReadMe.md

-PeTrack Version 0.8
-===================
+# PeTrack
 
 Software for tracking pedestrians.
 
 
-Installation, Uninstallation:
------------------------------
-Just execute PeTrackInstaller_<version>.exe and follow the instructions.
-To uninstall PeTrack execute PeTrackUninstaller.exe in the PeTrack application folder.
+## Installation, Uninstallation:
+To obtain the installer by following in the steps at https://www.fz-juelich.de/ias/ias-7/EN/Expertise/Software/PeTrack/petrackDownload.html.
+Afterwards just execute `petrack-installer_<version>.exe` and follow the instructions.
+To uninstall PeTrack execute `Uninstall.exe` in the PeTrack application folder.
 
 
-Usage:
-------
+## Usage:
 The command line options can be displayed by calling
+```bash
 petrack -help
+```
+
 Key bindings can be found in the help menu of the program.
 
-For more information see http://www.fz-juelich.de/jsc/petrack/.
+For more information see https://www.fz-juelich.de/ias/ias-7/EN/Expertise/Software/PeTrack/petrack.html.
 
 Normal usage is interactive usage.
 
 
-Example:
---------
+## Example:
 To generate trajectories from a single image sequence starting with frame000.jpg to
 with settings stored in project.pet, export tracker file tracker_file and exit
 with saving the project to project.pet again:
 
+```bash
 petrack.exe -project project.pet -sequence frame000.jpg -autoTrack tracker_file -autoSave project.pet
-
-
-History:
---------
-v0.1 : only camera calibration is supported; import and export of video and image sequence
-v0.2 : add first recognition
-v0.3 : recognition; tracking; color mapping
-v0.4 : tracking import and export; manual adding and deleting of trackpoints
-v0.5 : improve robustness of tracking with interpolation and extrapolation; first analysis functionality
-v0.6 : bug fixes; improve speed; expand visualization possibilities; add variable tracking region adapted to head size; provide program combine to merge trajectories
-v0.7 : introduce stereo cameras; alternate height
-       background subtraction especially for stereo cameras; recognition of unmarked pedestrians; integration of 4 disparity algorithms
-       filter to swap picture; more video codecs; color blobs as marker using HSV triangle
-       marker with two dots added; export of viewing direction
-v0.8 : slanted view for external calibration, coordinate system and grid is possible, introduced multicolor marker with black dot, video support for various codecs
-
-Using 
------
+```
+
+## Changelog:
+v0.8 : slanted view for external calibration, coordinate system and grid is possible, introduced multicolor marker with black dot, video support for various codecs <br/>
+v0.7 : introduce stereo cameras; alternate height <br/>
+       background subtraction especially for stereo cameras; recognition of unmarked pedestrians; integration of 4 disparity algorithms <br/>
+       filter to swap picture; more video codecs; color blobs as marker using HSV triangle <br/>
+       marker with two dots added; export of viewing direction <br/>
+v0.6 : bug fixes; improve speed; expand visualization possibilities; add variable tracking region adapted to head size; provide program combine to merge trajectories <br/>
+v0.5 : improve robustness of tracking with interpolation and extrapolation; first analysis functionality <br/>
+v0.4 : tracking import and export; manual adding and deleting of trackpoints <br/>
+v0.3 : recognition; tracking; color mapping <br/>
+v0.2 : add first recognition <br/>
+v0.1 : only camera calibration is supported; import and export of video and image sequence <br/>
+
+## Dependencies:
 * Qwt         (https://qwt.sf.net)
 * Qt          (https://www.qt.io/)
-* OpenCV      (https://opencv.org/)
\ No newline at end of file
+* OpenCV      (https://opencv.org/)

cmake_modules/install_helper.cmake

@@ -28,7 +28,7 @@ if (WIN32)
     install(FILES "${OpenCV_DIR}/LICENSE/" DESTINATION "Licenses/OpenCV_Licenses")
 endif()
 
-install(FILES "${CMAKE_SOURCE_DIR}/ReadMe.txt" "${CMAKE_SOURCE_DIR}/LICENSE" DESTINATION ".")
+install(FILES "${CMAKE_SOURCE_DIR}/ReadMe.md" "${CMAKE_SOURCE_DIR}/LICENSE" DESTINATION ".")
 
 
 ##################################################################
@@ -41,9 +41,9 @@ set(CPACK_PACKAGE_VERSION_MAJOR ${PROJECT_VERISON_MAJOR})
 set(CPACK_PACKAGE_VERSION_MINOR ${PROJECT_VERISON_MINOR})
 set(CPACK_PACKAGE_VERSION_PATCH ${PROJECT_VERISON_PATCH})
 set(CPACK_PACKAGE_DESCRIPTION "PeTrack is a software for the automated extraction of pedestrian trajectories from videos.")
-set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_SOURCE_DIR}/ReadMe.txt")
+set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_SOURCE_DIR}/ReadMe.md")
 set(CPACK_PACKAGE_HOMEPAGE_URL "https://www.fz-juelich.de/ias/ias-7/EN/Expertise/Software/PeTrack/petrack.html")
-set(CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/ReadMe.txt")
+set(CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/ReadMe.md")
 set(CPACK_PACKAGE_EXECUTABLES "petrack;PeTrack")
 set(CPACK_MONOLITHIC_INSTALL TRUE)
 set(CPACK_CREATE_DESKTOP_LINKS petrack)