diff -r 000000000000 -r 5cb36c12ac49 README --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README Mon Aug 31 07:12:16 2020 +0100 @@ -0,0 +1,35 @@ +General Information +=================== + +Plover is a front-end for the razor library intended to facilitate easy +integration with GLib and Gtk+. + +The official website for project beach (of which plover is one part) is: + + http://www.juiblex.co.uk/beach/ + +Installation +============ + +Installation is via the standard procedure: + +% ./configure +% make +# make install + +Tests +===== + +The main testsuite can be run using: + +% make check + +There are also a number of extended checks that use the main testsuite: + +% make distcheck # Standard automake target +% make check-code-coverage # Generate a coverage report for testsuite +% make check-valgrind # Generate memcheck, etc., reports + +Note that check-valgrind in particular is not expected to pass. That would +require no unsuppressed false positives under all versions of our dependencies, +which is too difficult to achieve.