projects/booket

diff README @ 32:06eba1bf219d

Exclude "." from tarballs
author Guido Berhoerster <guido+booket@berhoerster.name>
date Tue Sep 13 16:23:34 2016 +0200 (15 months ago)
parents 8445c729ba97
children
line diff
     1.1 --- a/README	Mon Sep 29 22:39:17 2014 +0200
     1.2 +++ b/README	Tue Sep 13 16:23:34 2016 +0200
     1.3 @@ -15,13 +15,44 @@
     1.4  Explorer, it can be placed and run from local storage or [from a
     1.5  webserver][1].
     1.6  
     1.7 -[1]: http://code.guido-berhoerster.org/booket/booket.html "Booket"
     1.8 +[1]: http://code.guido-berhoerster.org/projects/booket/booket.html "Booket"
     1.9  
    1.10  Build Instructions
    1.11  ------------------
    1.12  
    1.13 -Booket requires rsvg-convert from librsvg, Scour, xmllint, and GNU make in
    1.14 -order to strip down the included SVG images and to convert them to PNG format.
    1.15 +Distributions of released versions already include pregenerated images.
    1.16 +
    1.17 +The following tools are required to (re)generate the SVG and PNG images from
    1.18 +their sources:
    1.19 +
    1.20 +- GNU make >= 3.81
    1.21 +- rsvg-convert from librsvg
    1.22 +- Scour
    1.23 +- xmllint
    1.24 +
    1.25 +The following instructions assume that `make` is GNU make, on some platforms
    1.26 +it may be installed under a different name or a non-default path.  In order to
    1.27 +start the build process run `make all`.
    1.28 +
    1.29 +Previously generated images can be removed by running `make clean`.
    1.30 +
    1.31 +Contact
    1.32 +-------
    1.33 +
    1.34 +Please send any feedback, translations or bug reports via email to
    1.35 +<guido+booket@berhoerster.name>.
    1.36 +
    1.37 +Bug Reports
    1.38 +-----------
    1.39 +
    1.40 +When sending bug reports, please always mention the exact version of Booket
    1.41 +with which the issue occurs as well as the version of the browser and
    1.42 +operating system you are using and make sure that you provide sufficient
    1.43 +information to reproduce the issue and include any input, output, any error
    1.44 +messages.
    1.45 +
    1.46 +In case of build issues, please also specify the implementations and versions
    1.47 +of the tools you are using.
    1.48  
    1.49  License
    1.50  -------