Mercurial > projects > booket

comparison README @ 31:ffe69492fc67

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
30:1b56483fe0f2 31:ffe69492fc67
13 filter and search function. Booket is implemented in HTML5, ECMAScript 5.1, 13 filter and search function. Booket is implemented in HTML5, ECMAScript 5.1,
14 SVG 1.1 and CSS3 and works in all major recent browsers except Internet 14 SVG 1.1 and CSS3 and works in all major recent browsers except Internet
15 Explorer, it can be placed and run from local storage or [from a 15 Explorer, it can be placed and run from local storage or [from a
16 webserver][1]. 16 webserver][1].
17 17
18 [1]: http://code.guido-berhoerster.org/booket/booket.html "Booket" 18 [1]: http://code.guido-berhoerster.org/projects/booket/booket.html "Booket"
19 19
20 Build Instructions 20 Build Instructions
21 ------------------ 21 ------------------
22 22
23 Booket requires rsvg-convert from librsvg, Scour, xmllint, and GNU make in 23 Distributions of released versions already include pregenerated images.
24 order to strip down the included SVG images and to convert them to PNG format. 24
25 The following tools are required to (re)generate the SVG and PNG images from
26 their sources:
27
28 - GNU make >= 3.81
29 - rsvg-convert from librsvg
30 - Scour
31 - xmllint
32
33 The following instructions assume that `make` is GNU make, on some platforms
34 it may be installed under a different name or a non-default path. In order to
35 start the build process run `make all`.
36
37 Previously generated images can be removed by running `make clean`.
38
39 Contact
40 -------
41
42 Please send any feedback, translations or bug reports via email to
43 <guido+booket@berhoerster.name>.
44
45 Bug Reports
46 -----------
47
48 When sending bug reports, please always mention the exact version of Booket
49 with which the issue occurs as well as the version of the browser and
50 operating system you are using and make sure that you provide sufficient
51 information to reproduce the issue and include any input, output, any error
52 messages.
53
54 In case of build issues, please also specify the implementations and versions
55 of the tools you are using.
25 56
26 License 57 License
27 ------- 58 -------
28 59
29 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and 60 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and