updates for release

CHANGELOG.md

@@ -1,3 +1,39 @@
+# 0.7.0
+
+2014-07-09
+
+  * New Features:
+    - Added automatic programme filter generation, set by `konopas_set.filters`
+    - Added automatic people paging, set by `konopas_set.people_per_screen`
+    - Removed Next view, added "Now" to Program view
+  * Code:
+    - Split src/app.js into multiple files
+    - Cleaned up almost all functions & data into a `KonOpas` namespace, with an
+      instance `konopas`
+    - Moved program sorting from KonOpas.Item.show_list to KonOpas.Prog
+    - Added polyfills for function.bind() & string.normalize()
+    - Removed from git tracking: konopas*.js
+  * Localization:
+    - Support for simultaneous multi-lingual use, req. supporting
+      messageformat.js (0.2.0)
+    - better localized date & weekday handling, with custom polyfill for
+      date.toLocaleDateString()
+    - Removed from git tracking: i18n/*.js
+  * Skin:
+    - Added -ms-high-contrast rule for item select boxes in IE10 & later
+    - Switched CSS compressor to clean-css (was yui-compress)
+    - Split fonts.less from main.less; cleaned up fonts.css
+    - Removed from git tracking: skin/skin.css, skin/PTSansNarrow700.ttf and
+      skin/RobotoCondensed400.ttf
+  * Util:
+    - lib/gdrive2json.php: added Google's new URL scheme (check your path for
+      either `/d/` or `/ccc?`)
+    - Reorganised everything
+    - Removed android-wrapper & config.html
+  * Updated the sample artwork
+  * Lots and lots of bugfixes, in particular increasing robustness to bad data
+
+
 # 0.6.2
 
 2014-06-04

README.md

@@ -4,8 +4,8 @@ KonOpas
 A mobile-friendly guide for conventions, with all sorts of spiffy features.
 
 
-**KonOpas** is free, open-source software distributed under the terms of the ISC
-license:
+**[KonOpas]** is free, open-source software distributed under the terms of the
+ISC license:
 
 	Copyright (c) 2013-2014 by Eemeli Aro <[email protected]>
 
@@ -35,6 +35,12 @@ The hosting requirements for KonOpas are minimal, as all the processing is done
 by the browser; all the files are served statically. Some back-end scripting may
 be required if you require live updates of the programme during the event.
 
+Built and tested for a growing number of large and small conventions and
+conferences, KonOpas is about as easy to use as possible. With automatic filter
+rule generation from your data, KonOpas can be set up for your event by just
+adding your name and logo to an HTML file, along with pointers to your
+programme and participant data.
+
 The open-source KonOpas client can also talk with a dedicated KonOpas server.
 The server enables item sync across different browsers, devices and calendar
 apps; item-specific voting and commenting; and allows the event organisers to
@@ -49,30 +55,48 @@ For links to example instances of KonOpas, take a look at the links from our
 
 ## Getting Started
 
-As KonOpas is just a front end for your event's programme, you'll need to
-actually manage your programme with a different tool. So far we've got built-in
+As KonOpas is a front end for your event's programme, you'll need to actually
+manage your programme with a different tool. So far we've got built-in
 integration with at least [Conference Planner]/[Grenadine] and [Zambia], with
-more to come. For smaller events, a simple [PHP script] is included for fetching
-data from a publicly readable Google Drive Spreadsheet and converting it to the
-[KonOpas format][KO-fmt].
-
-Once you've got your programme data in the [proper format][KO-fmt], you can use
-our [configurator][KO-cfg] to get you started with customizing KonOpas for your
-event. That'll produce snippets of HTML that you can place into the included
-`index.html` file, mainly so that you can get the initial filters to match your
-programme data (each item's day, location and tags, if any). You should tune
-these to your liking, and follow the included examples for second-level menus if
-necessary. Don't forget to change the `data/program.js` and/or `data/people.js`
-scripts that are included from `index.html`! Accessing the programme database at
-a different domain should be fine, provided that it's not served over HTTPS.
-
-KonOpas takes a few optional parameters that you should define with the
-`konopas_set` object; to see what's available, take a look at the `src/app.js`
-file. To change the gudie's appearance, you should make changes directly into
-`index.html`, eg. replacing the title graphics with your own. For more in-depth
-changes such as changes to the color scheme or fonts, you'll need to edit the
-`skin/*.less` files and recompile them into CSS. For internationalization and
-other needs, we have a few other [utilities][KO-util] available.
+more to come. For smaller events, a simple [PHP script] is available for
+fetching data from a publicly readable Google Drive Spreadsheet and converting
+it to the [KonOpas format][KO-fmt].
+
+[Conference Planner]: http://sourceforge.net/projects/conferenceplan/
+[Grenadine]: http://events.grenadine.co/
+[Zambia]: http://sourceforge.net/projects/zambia/
+[PHP script]: https://github.com/eemeli/konopas/tree/master/util/gdrive2js
+[KO-fmt]: http://konopas.org/data-fmt
+
+
+To get started, you should download the [latest release of KonOpas][KO-latest],
+which includes the compiled & minified Javascript and CSS files. Alternatively,
+if you clone the [repository][KO-repo], you'll have a much easier time of
+making changes to the skin or hacking the Javascript source, but you'll need to
+compile the code yourself---instructions for that are in the following section.
+
+[KO-latest]: https://github.com/eemeli/konopas/releases/latest
+[KO-repo]: https://github.com/eemeli/konopas
+
+
+Once you've got your programme data in the [proper format][KO-fmt], you should
+just change the `<script>` tags at the bottom of `index.html` to point to your
+data, and open the page in a web browser. If all goes well, you should see your
+programme nearly ready to use! If there are problems, the first place to look
+for more information is your browser's developer console.
+
+To start customizing KonOpas for your event, edit the HTML file by replacing
+stand-in phrases like `KonOpas Sample Guide` and `CONVENTION` as appropriate.
+The `title` and `title-small` images are the logo that's displayed at the top of
+the page; there are two as you may wish to use a different graphic for the wide
+and narrow-aspect layouts. Near the bottom of the file you'll find the
+definition of a Javascript object `konopas_set` that's used to [configure the
+guide][KO-cfg].
+
+For more in-depth changes such as changes to the color scheme or fonts, you'll
+need to edit the `skin/*.less` files and recompile them into CSS. For
+internationalization and other needs, we have a few other [utilities][KO-util]
+available.
 
 The HTML5 [cache manifest] is by default not enabled, as it makes testing and
 development a bit of a hassle. To enable, you should update the contents of
@@ -81,12 +105,7 @@ development a bit of a hassle. To enable, you should update the contents of
 `text/cache-manifest` MIME type, and that the manifest doesn't include itself,
 as debugging a bad manifest can be tricky.
 
-[Conference Planner]: http://sourceforge.net/projects/conferenceplan/
-[Grenadine]: http://events.grenadine.co/
-[Zambia]: http://sourceforge.net/projects/zambia/
-[PHP script]: https://github.com/eemeli/konopas/tree/master/util/gdrive2js
-[KO-fmt]: http://konopas.org/data-fmt
-[KO-cfg]: http://konopas.org/util/config
+[KO-cfg]: http://konopas.org/config
 [KO-util]: http://konopas.org/util/
 [cache manifest]: http://en.wikipedia.org/wiki/Cache_manifest_in_HTML5
 
@@ -105,7 +124,8 @@ your needs.
 For **internationalization**, we use Alex Sexton's [messageformat.js]. If you'd
 like to implement your own localization, the easiest way is probably to use our
 [online i18n js generator][KO-i18n] and to save the output as `i18n/$LC.js`. So
-far localizations include English, Finnish, and Swedish.
+far localizations include English, Finnish, and Swedish. Support for multi-
+lingual instances requires messageformat.js 0.2.0 or later.
 
 [LESS]: http://lesscss.org/
 [messageformat.js]: https://github.com/SlexAxton/messageformat.js

package.json

@@ -1,6 +1,6 @@
 {
   "name": "konopas",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "author": "Eemeli Aro <[email protected]>",
   "description": "KonOpas: A mobile-friendly guide for conventions, with all sorts of spiffy features",
   "keywords": ["convention", "conference", "mobile guide", "programme guide"],