Mercurial > projects > booket

annotate README @ 32:06eba1bf219d default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Exclude "." from tarballs
author Guido Berhoerster <guido+booket@berhoerster.name>
date Tue, 13 Sep 2016 16:23:34 +0200
parents ffe69492fc67
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
1 Booket
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
2 ======
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
3
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
4 Description
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
5 -----------
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
6
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
7 Booket is a browser-agnostic and portable bookmark manager with a focus on
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
8 simplicity which runs entirely locally in the browser. Bookmarks can be loaded
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
9 from and saved to a local file in a simple JSON-based file format. For
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
10 interoperability with browsers' native bookmarks Booket can also import and
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
11 export bookmarks in the Netscape file format. Bookmarks can be categorized
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
12 with tags allowing them to be easily located later through the built-in tag
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
13 filter and search function. Booket is implemented in HTML5, ECMAScript 5.1,
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
14 SVG 1.1 and CSS3 and works in all major recent browsers except Internet
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
15 Explorer, it can be placed and run from local storage or [from a
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
16 webserver][1].
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
17
31
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
18 [1]: http://code.guido-berhoerster.org/projects/booket/booket.html "Booket"
13
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
19
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
20 Build Instructions
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
21 ------------------
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
22
31
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
23 Distributions of released versions already include pregenerated images.
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
24
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
25 The following tools are required to (re)generate the SVG and PNG images from
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
26 their sources:
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
27
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
28 - GNU make >= 3.81
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
29 - rsvg-convert from librsvg
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
30 - Scour
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
31 - xmllint
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
32
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
33 The following instructions assume that `make` is GNU make, on some platforms
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
34 it may be installed under a different name or a non-default path. In order to
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
35 start the build process run `make all`.
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
36
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
37 Previously generated images can be removed by running `make clean`.
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
38
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
39 Contact
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
40 -------
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
41
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
42 Please send any feedback, translations or bug reports via email to
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
43 <guido+booket@berhoerster.name>.
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
44
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
45 Bug Reports
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
46 -----------
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
47
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
48 When sending bug reports, please always mention the exact version of Booket
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
49 with which the issue occurs as well as the version of the browser and
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
50 operating system you are using and make sure that you provide sufficient
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
51 information to reproduce the issue and include any input, output, any error
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
52 messages.
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
53
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
54 In case of build issues, please also specify the implementations and versions
ffe69492fc67 Improve README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents: 17
diff changeset
55 of the tools you are using.
13
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
56
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
57 License
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
58 -------
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
59
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
60 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
61 distributed under the following license terms:
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
62
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
63 Copyright (C) 2014 Guido Berhoerster <guido+booket@berhoerster.name>
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
64
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
65 Permission is hereby granted, free of charge, to any person obtaining
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
66 a copy of this software and associated documentation files (the
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
67 "Software"), to deal in the Software without restriction, including
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
68 without limitation the rights to use, copy, modify, merge, publish,
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
69 distribute, sublicense, and/or sell copies of the Software, and to
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
70 permit persons to whom the Software is furnished to do so, subject to
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
71 the following conditions:
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
72
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
73 The above copyright notice and this permission notice shall be included
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
74 in all copies or substantial portions of the Software.
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
75
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
76 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
77 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
78 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
79 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
80 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
81 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
82 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.