comparison README @ 13:bd822f25e285 version-3

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
comparison
equal deleted inserted replaced
12:948048e40fab 13:bd822f25e285
1 Booket
2 ======
3
4 Description
5 -----------
6
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].
17
18 [1]: http://code.guido-berhoerster.org/booket/booket.html "Booket"
19
20 Build Instructions
21 ------------------
22
23 Booket requires Scour, xmllint, and GNU make in order to strip down the
24 included SVG images.
25
26 License
27 -------
28
29 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and
30 distributed under the following license terms:
31
32 Copyright (C) 2014 Guido Berhoerster <guido+booket@berhoerster.name>
33
34 Permission is hereby granted, free of charge, to any person obtaining
35 a copy of this software and associated documentation files (the
36 "Software"), to deal in the Software without restriction, including
37 without limitation the rights to use, copy, modify, merge, publish,
38 distribute, sublicense, and/or sell copies of the Software, and to
39 permit persons to whom the Software is furnished to do so, subject to
40 the following conditions:
41
42 The above copyright notice and this permission notice shall be included
43 in all copies or substantial portions of the Software.
44
45 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
46 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
47 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
48 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
49 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
50 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
51 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.