Mercurial > projects > booket

annotate README @ 13:bd822f25e285 version-3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add README file Add a README file with build instructions and a description
author Guido Berhoerster <guido+booket@berhoerster.name>
date Thu, 18 Sep 2014 20:35:42 +0200
parents
children 8445c729ba97
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
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
18 [1]: http://code.guido-berhoerster.org/booket/booket.html "Booket"
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
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
23 Booket requires Scour, xmllint, and GNU make in order to strip down the
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
24 included SVG images.
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
25
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
26 License
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
27 -------
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
28
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
29 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
30 distributed under the following license terms:
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
31
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
32 Copyright (C) 2014 Guido Berhoerster <guido+booket@berhoerster.name>
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
33
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
34 Permission is hereby granted, free of charge, to any person obtaining
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
35 a copy of this software and associated documentation files (the
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
36 "Software"), to deal in the Software without restriction, including
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
37 without limitation the rights to use, copy, modify, merge, publish,
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
38 distribute, sublicense, and/or sell copies of the Software, and to
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
39 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
40 the following conditions:
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
41
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
42 The above copyright notice and this permission notice shall be included
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
43 in all copies or substantial portions of the Software.
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
44
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
45 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
46 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
47 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
48 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
49 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
bd822f25e285 Add README file
Guido Berhoerster <guido+booket@berhoerster.name>
parents:
diff changeset
50 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
51 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.