1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Fri Jul 08 08:26:29 2016 +0100
     1.3 @@ -0,0 +1,35 @@
     1.4 +General Information
     1.5 +===================
     1.6 +
     1.7 +Plover is a front-end for the razor library intended to facilitate easy
     1.8 +integration with GLib and Gtk+.
     1.9 +
    1.10 +The official website for project beach (of which plover is one part) is:
    1.11 +
    1.12 +  http://www.juiblex.co.uk/beach/
    1.13 +
    1.14 +Installation
    1.15 +============
    1.16 +
    1.17 +Installation is via the standard procedure:
    1.18 +
    1.19 +% ./configure
    1.20 +% make
    1.21 +# make install              
    1.22 +
    1.23 +Tests
    1.24 +=====
    1.25 +
    1.26 +The main testsuite can be run using:
    1.27 +
    1.28 +% make check
    1.29 +
    1.30 +There are also a number of extended checks that use the main testsuite:
    1.31 +
    1.32 +% make distcheck		# Standard automake target
    1.33 +% make check-code-coverage	# Generate a coverage report for testsuite
    1.34 +% make check-valgrind		# Generate memcheck, etc., reports
    1.35 +
    1.36 +Note that check-valgrind in particular is not expected to pass. That would
    1.37 +require no unsuppressed false positives under all versions of our dependencies,
    1.38 +which is too difficult to achieve.