projects/booket

view 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 Jan 29 10:28:28 2015 +0100 (2015-01-29)
parents 8445c729ba97
children
line source
1 Booket
2 ======
4 Description
5 -----------
7 Booket is a browser-agnostic and portable bookmark manager with a focus on
8 simplicity which runs entirely locally in the browser. Bookmarks can be loaded
9 from and saved to a local file in a simple JSON-based file format. For
10 interoperability with browsers' native bookmarks Booket can also import and
11 export bookmarks in the Netscape file format. Bookmarks can be categorized
12 with tags allowing them to be easily located later through the built-in tag
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
15 Explorer, it can be placed and run from local storage or [from a
16 webserver][1].
18 [1]: http://code.guido-berhoerster.org/projects/booket/booket.html "Booket"
20 Build Instructions
21 ------------------
23 Distributions of released versions already include pregenerated images.
25 The following tools are required to (re)generate the SVG and PNG images from
26 their sources:
28 - GNU make >= 3.81
29 - rsvg-convert from librsvg
30 - Scour
31 - xmllint
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`.
37 Previously generated images can be removed by running `make clean`.
39 Contact
40 -------
42 Please send any feedback, translations or bug reports via email to
43 <guido+booket@berhoerster.name>.
45 Bug Reports
46 -----------
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.
54 In case of build issues, please also specify the implementations and versions
55 of the tools you are using.
57 License
58 -------
60 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and
61 distributed under the following license terms:
63 Copyright (C) 2014 Guido Berhoerster <guido+booket@berhoerster.name>
65 Permission is hereby granted, free of charge, to any person obtaining
66 a copy of this software and associated documentation files (the
67 "Software"), to deal in the Software without restriction, including
68 without limitation the rights to use, copy, modify, merge, publish,
69 distribute, sublicense, and/or sell copies of the Software, and to
70 permit persons to whom the Software is furnished to do so, subject to
71 the following conditions:
73 The above copyright notice and this permission notice shall be included
74 in all copies or substantial portions of the Software.
76 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
77 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
78 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
79 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
80 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
81 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
82 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.