projects/booket

annotate README @ 13:bd822f25e285

Add README file

Add a README file with build instructions and a description
author Guido Berhoerster <guido+booket@berhoerster.name>
date Thu Sep 18 20:35:42 2014 +0200 (2014-09-18)
parents
children 8445c729ba97
rev   line source
guido+booket@13 1 Booket
guido+booket@13 2 ======
guido+booket@13 3
guido+booket@13 4 Description
guido+booket@13 5 -----------
guido+booket@13 6
guido+booket@13 7 Booket is a browser-agnostic and portable bookmark manager with a focus on
guido+booket@13 8 simplicity which runs entirely locally in the browser. Bookmarks can be loaded
guido+booket@13 9 from and saved to a local file in a simple JSON-based file format. For
guido+booket@13 10 interoperability with browsers' native bookmarks Booket can also import and
guido+booket@13 11 export bookmarks in the Netscape file format. Bookmarks can be categorized
guido+booket@13 12 with tags allowing them to be easily located later through the built-in tag
guido+booket@13 13 filter and search function. Booket is implemented in HTML5, ECMAScript 5.1,
guido+booket@13 14 SVG 1.1 and CSS3 and works in all major recent browsers except Internet
guido+booket@13 15 Explorer, it can be placed and run from local storage or [from a
guido+booket@13 16 webserver][1].
guido+booket@13 17
guido+booket@13 18 [1]: http://code.guido-berhoerster.org/booket/booket.html "Booket"
guido+booket@13 19
guido+booket@13 20 Build Instructions
guido+booket@13 21 ------------------
guido+booket@13 22
guido+booket@13 23 Booket requires Scour, xmllint, and GNU make in order to strip down the
guido+booket@13 24 included SVG images.
guido+booket@13 25
guido+booket@13 26 License
guido+booket@13 27 -------
guido+booket@13 28
guido+booket@13 29 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and
guido+booket@13 30 distributed under the following license terms:
guido+booket@13 31
guido+booket@13 32 Copyright (C) 2014 Guido Berhoerster <guido+booket@berhoerster.name>
guido+booket@13 33
guido+booket@13 34 Permission is hereby granted, free of charge, to any person obtaining
guido+booket@13 35 a copy of this software and associated documentation files (the
guido+booket@13 36 "Software"), to deal in the Software without restriction, including
guido+booket@13 37 without limitation the rights to use, copy, modify, merge, publish,
guido+booket@13 38 distribute, sublicense, and/or sell copies of the Software, and to
guido+booket@13 39 permit persons to whom the Software is furnished to do so, subject to
guido+booket@13 40 the following conditions:
guido+booket@13 41
guido+booket@13 42 The above copyright notice and this permission notice shall be included
guido+booket@13 43 in all copies or substantial portions of the Software.
guido+booket@13 44
guido+booket@13 45 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
guido+booket@13 46 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
guido+booket@13 47 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
guido+booket@13 48 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
guido+booket@13 49 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
guido+booket@13 50 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
guido+booket@13 51 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.