projects/booket

changeset 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 Sep 18 20:35:42 2014 +0200 (2014-09-18)
parents 948048e40fab
children 94c14a07fa6d
files README
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Thu Sep 18 20:35:42 2014 +0200
     1.3 @@ -0,0 +1,51 @@
     1.4 +Booket
     1.5 +======
     1.6 +
     1.7 +Description
     1.8 +-----------
     1.9 +
    1.10 +Booket is a browser-agnostic and portable bookmark manager with a focus on
    1.11 +simplicity which runs entirely locally in the browser. Bookmarks can be loaded
    1.12 +from and saved to a local file in a simple JSON-based file format. For
    1.13 +interoperability with browsers' native bookmarks Booket can also import and
    1.14 +export bookmarks in the Netscape file format. Bookmarks can be categorized
    1.15 +with tags allowing them to be easily located later through the built-in tag
    1.16 +filter and search function. Booket is implemented in HTML5, ECMAScript 5.1,
    1.17 +SVG 1.1 and CSS3 and works in all major recent browsers except Internet
    1.18 +Explorer, it can be placed and run from local storage or [from a
    1.19 +webserver][1].
    1.20 +
    1.21 +[1]: http://code.guido-berhoerster.org/booket/booket.html "Booket"
    1.22 +
    1.23 +Build Instructions
    1.24 +------------------
    1.25 +
    1.26 +Booket requires Scour, xmllint, and GNU make in order to strip down the
    1.27 +included SVG images.
    1.28 +
    1.29 +License
    1.30 +-------
    1.31 +
    1.32 +Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and
    1.33 +distributed under the following license terms:
    1.34 +
    1.35 +Copyright (C) 2014 Guido Berhoerster <guido+booket@berhoerster.name>
    1.36 +
    1.37 +Permission is hereby granted, free of charge, to any person obtaining
    1.38 +a copy of this software and associated documentation files (the
    1.39 +"Software"), to deal in the Software without restriction, including
    1.40 +without limitation the rights to use, copy, modify, merge, publish,
    1.41 +distribute, sublicense, and/or sell copies of the Software, and to
    1.42 +permit persons to whom the Software is furnished to do so, subject to
    1.43 +the following conditions:
    1.44 +
    1.45 +The above copyright notice and this permission notice shall be included
    1.46 +in all copies or substantial portions of the Software.
    1.47 +
    1.48 +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    1.49 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    1.50 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    1.51 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
    1.52 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
    1.53 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
    1.54 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.