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