From 2dde9b95e04072aa735a1b8da044aee34989a516 Mon Sep 17 00:00:00 2001 From: Erik Auerswald Date: Thu, 30 May 2019 13:37:28 +0200 Subject: [PATCH] README: improve installation information This adds information relevant to issue #9 to the README file. Before, the information was added to the ssocr home page and the GitHub issue tracker only. --- README | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README b/README index 1ed99fb..1553ec6 100644 --- a/README +++ b/README @@ -1,12 +1,16 @@ Seven Segment Optical Character Recognition or ssocr for short is a program to recognize digits of a seven segment display. An image of one -row of digits is used for input and the recognized number is written to -the standard output. The program runs on GNU/Linux, FreeBSD (available as -a port), Mac OS X (using Homebrew to install Imlib2), and even on Windows -(using Cygwin). ssocr should work on any UNIX-like or POSIX compatible -operating system. +row of digits is used for input and the recognized number is written +to the standard output. The program runs on GNU/Linux (some GNU/Linux +distributions provide an ssocr package), FreeBSD (available as a port +as well), Mac OS X (Homebrew can be used to install the library Imlib2, +used by ssocr), and even on Windows (using Cygwin). ssocr should work +on any UNIX-like or POSIX compatible operating system. -See the INSTALL file for instructions on how to build ssocr. +Unless ssocr is installed via some packaging system, e.g. from a GNU/Linux +distribution, it is distributed in source form and needs to be built +before it can be used. See the INSTALL file for instructions on how to +build ssocr. A manual for ssocr is available in the form of a man page named ssocr.1, you can read it using "make ssocr.1 && man ./ssocr.1" (without the