From 1c1df12e5a4a25c7d9fd3cd329bbe06f8aac60d3 Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Fri, 8 Feb 2013 11:01:44 +0000 Subject: [PATCH] [#312,README][s]: note about using jekyll to build docs or demos if working on them locally. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 65851a30..ae3fd66d 100755 --- a/README.md +++ b/README.md @@ -17,6 +17,14 @@ A simple but powerful library for building data applications in pure Javascript Run the tests by opening `test/index.html` in your browser. +Note that the demos and documentation utilize the [jekyll templating +system][jekyll] and to use them *locally* you will need to build them using +jekyll. Once installed, all you need to do from the command line is run jekyll: + + jekyll + +[jekyll]: https://github.com/mojombo/jekyll + Notes on the architecture can be found in the [documentation online](http://okfnlabs.org/recline). ### Contributing