Skip to content

Commit

Permalink
updates for release 0.6.2
Browse files Browse the repository at this point in the history
  • Loading branch information
eemeli committed Jun 4, 2014
1 parent 08ff488 commit a017802
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 31 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
# 0.6.2

2014-06-04

* Added Gulp.js based build system (thanks to [akx](https://github.com/akx/))
* Localization improvements:
- Added Finnish (again, thanks to akx)
- added i18n/README.md for translators
- added separate i18n/{en,fi,sv}.js files
- relaxed MessageFormat version dependence
* allow people array to be missing or empty


# 0.6.1

2014-03-25
Expand Down
62 changes: 41 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ 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.
[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
Expand Down Expand Up @@ -93,35 +93,55 @@ as debugging a bad manifest can be tricky.

## Compilation & Dependencies

For most use cases, KonOpas should be usable directly. However, if you'd like to
change things such as the interface language, or if you'd like to just poke
under the hood in general, you have two options based on different **build
environments**, [make](#user-content-make) and [gulp](#user-content-gulp).

For **styling**, KonOpas uses [LESS], which requires compilation into CSS if
modified. This should make it easier for you to tune the default KonOpas skin to
match your needs.

For **internationalization**, we use a [custom branch][MF-fill] of Alex Sexton's
[messageformat.js], with a few features that haven't been included in the master
(yet). 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/i18n.js`. So far localizations include English, Finnish, and Swedish.

For **JavaScript minification**, we use the [javascript-minifier.com] service's
HTTP API.

For ease of use during development, all of the above are accessible from the
included `Makefile`. Provided that the above dependencies are installed, `make
dev` should provide a development version of KonOpas and `make prod` a version
that ready to deploy. Note that the appropriate `<script>` tag in `index.html`
will also be updated to reflect the version in use. If you've [Watchman]
installed, `make watch` will start it with triggers for automatically updating
the JS & CSS files during development.
modified. This should make it easier for you to tune the default skin to match
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.

[LESS]: http://lesscss.org/
[MF-fill]: https://github.com/eemeli/messageformat.js/tree/fill
[messageformat.js]: https://github.com/SlexAxton/messageformat.js
[KO-i18n]: http://konopas.org/util/i18n/


### make

Using make will require separately installing the [LESS] and [messageformat.js]
dependencies, but only if you intend to change the styling or localization
source files.

A `Makefile` is included, with a default target `dev` for a development version
and `prod`, which minifies the previous using the [javascript-minifier.com]
service's HTTP API. These targets will also modify the appropriate `<script>`
tag in `index.html` to reflect the version in use.

If you've [Watchman] installed, `make watch` will start it with triggers for
automatically updating the JS & CSS files during development.

[javascript-minifier.com]: http://javascript-minifier.com/
[Watchman]: https://github.com/facebook/watchman


### gulp

To automatically install the dependencies required by [gulp.js], run
`npm install` in the directory in which you've installed KonOpas. Then try
running `gulp --locale en` to get a list of the available targets.

The gulp.js build system was implemented for KonOpas by [Aarni Koskela][akx].

[gulp.js]: http://gulpjs.com/
[akx]: https://github.com/akx/


## Discussion

We have a public [mailing list][KO-list] that you're welcome to join, or just
Expand Down
4 changes: 4 additions & 0 deletions i18n/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,7 @@ http://www.konopas.org/util/i18n/en.json
You are most welcome to contribute your localizations to the project, either by
adding a GitHub pull request for the .json file or by e-mailing it to:
[email protected]

Two sed scripts, `json2po` and `po2json`, are included to help reformat the
source translation files to and from GetText .po files, which may be easier to
handle with conventional translation tools.
17 changes: 7 additions & 10 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,22 +1,19 @@
{
"name": "konopas",
"version": "0.0.0",
"description": "Konopas",
"main": "-",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"version": "0.6.2",
"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"],
"homepage": "http://konopas.org/",
"license": "ISC",
"repository": {
"type": "git",
"url": "https://github.com/eemeli/konopas.git"
},
"author": "",
"license": "ISC",
"bugs": {
"url": "https://github.com/eemeli/konopas/issues"
},
"homepage": "https://github.com/eemeli/konopas",
"dependencies": {
"devDependencies": {
"glob": "^4.0.0",
"gulp": "^3.7.0",
"gulp-concat": "^2.2.0",
Expand Down

0 comments on commit a017802

Please sign in to comment.