projects/booket

annotate README @ 32:06eba1bf219d

Exclude "." from tarballs
author Guido Berhoerster <guido+booket@berhoerster.name>
date Tue Sep 13 16:23:34 2016 +0200 (15 months ago)
parents 8445c729ba97
children
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@31 18 [1]: http://code.guido-berhoerster.org/projects/booket/booket.html "Booket"
guido+booket@13 19
guido+booket@13 20 Build Instructions
guido+booket@13 21 ------------------
guido+booket@13 22
guido+booket@31 23 Distributions of released versions already include pregenerated images.
guido+booket@31 24
guido+booket@31 25 The following tools are required to (re)generate the SVG and PNG images from
guido+booket@31 26 their sources:
guido+booket@31 27
guido+booket@31 28 - GNU make >= 3.81
guido+booket@31 29 - rsvg-convert from librsvg
guido+booket@31 30 - Scour
guido+booket@31 31 - xmllint
guido+booket@31 32
guido+booket@31 33 The following instructions assume that `make` is GNU make, on some platforms
guido+booket@31 34 it may be installed under a different name or a non-default path. In order to
guido+booket@31 35 start the build process run `make all`.
guido+booket@31 36
guido+booket@31 37 Previously generated images can be removed by running `make clean`.
guido+booket@31 38
guido+booket@31 39 Contact
guido+booket@31 40 -------
guido+booket@31 41
guido+booket@31 42 Please send any feedback, translations or bug reports via email to
guido+booket@31 43 <guido+booket@berhoerster.name>.
guido+booket@31 44
guido+booket@31 45 Bug Reports
guido+booket@31 46 -----------
guido+booket@31 47
guido+booket@31 48 When sending bug reports, please always mention the exact version of Booket
guido+booket@31 49 with which the issue occurs as well as the version of the browser and
guido+booket@31 50 operating system you are using and make sure that you provide sufficient
guido+booket@31 51 information to reproduce the issue and include any input, output, any error
guido+booket@31 52 messages.
guido+booket@31 53
guido+booket@31 54 In case of build issues, please also specify the implementations and versions
guido+booket@31 55 of the tools you are using.
guido+booket@13 56
guido+booket@13 57 License
guido+booket@13 58 -------
guido+booket@13 59
guido+booket@13 60 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and
guido+booket@13 61 distributed under the following license terms:
guido+booket@13 62
guido+booket@13 63 Copyright (C) 2014 Guido Berhoerster <guido+booket@berhoerster.name>
guido+booket@13 64
guido+booket@13 65 Permission is hereby granted, free of charge, to any person obtaining
guido+booket@13 66 a copy of this software and associated documentation files (the
guido+booket@13 67 "Software"), to deal in the Software without restriction, including
guido+booket@13 68 without limitation the rights to use, copy, modify, merge, publish,
guido+booket@13 69 distribute, sublicense, and/or sell copies of the Software, and to
guido+booket@13 70 permit persons to whom the Software is furnished to do so, subject to
guido+booket@13 71 the following conditions:
guido+booket@13 72
guido+booket@13 73 The above copyright notice and this permission notice shall be included
guido+booket@13 74 in all copies or substantial portions of the Software.
guido+booket@13 75
guido+booket@13 76 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
guido+booket@13 77 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
guido+booket@13 78 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
guido+booket@13 79 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
guido+booket@13 80 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
guido+booket@13 81 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
guido+booket@13 82 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.