README
author J. Ali Harlow <ali@juiblex.co.uk>
Fri Jul 08 07:50:42 2016 +0100 (2016-07-08)
changeset 57 e0f448fb54a5
permissions -rw-r--r--
Tests shouldn't fail if RAZOR_ROOT is set in the environment
     1 General Information
     2 ===================
     3 
     4 Plover is a front-end for the razor library intended to facilitate easy
     5 integration with GLib and Gtk+.
     6 
     7 The official website for project beach (of which plover is one part) is:
     8 
     9   http://www.juiblex.co.uk/beach/
    10 
    11 Installation
    12 ============
    13 
    14 Installation is via the standard procedure:
    15 
    16 % ./configure
    17 % make
    18 # make install              
    19 
    20 Tests
    21 =====
    22 
    23 The main testsuite can be run using:
    24 
    25 % make check
    26 
    27 There are also a number of extended checks that use the main testsuite:
    28 
    29 % make distcheck		# Standard automake target
    30 % make check-code-coverage	# Generate a coverage report for testsuite
    31 % make check-valgrind		# Generate memcheck, etc., reports
    32 
    33 Note that check-valgrind in particular is not expected to pass. That would
    34 require no unsuppressed false positives under all versions of our dependencies,
    35 which is too difficult to achieve.