Mercurial > projects > booket
diff README @ 31:ffe69492fc67
Improve README file
Adjust URL of the online version.
Extend build instructions.
Add information on bug reporting.
Add contact information.
author | Guido Berhoerster <guido+booket@berhoerster.name> |
---|---|
date | Thu, 29 Jan 2015 10:28:28 +0100 |
parents | 8445c729ba97 |
children |
line wrap: on
line diff
--- a/README Fri Jan 23 11:01:48 2015 +0100 +++ b/README Thu Jan 29 10:28:28 2015 +0100 @@ -15,13 +15,44 @@ Explorer, it can be placed and run from local storage or [from a webserver][1]. -[1]: http://code.guido-berhoerster.org/booket/booket.html "Booket" +[1]: http://code.guido-berhoerster.org/projects/booket/booket.html "Booket" Build Instructions ------------------ -Booket requires rsvg-convert from librsvg, Scour, xmllint, and GNU make in -order to strip down the included SVG images and to convert them to PNG format. +Distributions of released versions already include pregenerated images. + +The following tools are required to (re)generate the SVG and PNG images from +their sources: + +- GNU make >= 3.81 +- rsvg-convert from librsvg +- Scour +- xmllint + +The following instructions assume that `make` is GNU make, on some platforms +it may be installed under a different name or a non-default path. In order to +start the build process run `make all`. + +Previously generated images can be removed by running `make clean`. + +Contact +------- + +Please send any feedback, translations or bug reports via email to +<guido+booket@berhoerster.name>. + +Bug Reports +----------- + +When sending bug reports, please always mention the exact version of Booket +with which the issue occurs as well as the version of the browser and +operating system you are using and make sure that you provide sufficient +information to reproduce the issue and include any input, output, any error +messages. + +In case of build issues, please also specify the implementations and versions +of the tools you are using. License -------