README

=============
Kay Framework
=============

What's this
-----------

Kay is a web framework completely specialising on Google App
Engine. But basic design is based on the Django framework, like
middleware, settings and pluggable application, etc. Kay uses Werkzeug
as lower level framework, uses Jinja2 as template engine, uses babel
for handling language translations. This software is distributed under
BSD license. See LICENSE for the details.


The software that Kay bundles
-----------------------------
* babel
* jinja2
* simplejson
* werkzeug
* pytz

Dependencies
------------
* Google App Engine SDK

  If you installed zip version of the SDK(most unix style operation
  system users are so), don't forget to create a symlink pointed to
  the real SDK at /usr/local/google_appengine.
  
.. code-block:: bash

   $ sudo ln -s /some/whare/google_appengine /usr/local/google_appengine    


Manuals
-------

* quickstart
  docs/source/quickstart.rst

* URL Mapping
  docs/source/urlmapping.rst

* Form manual
  docs/source/forms-usage.rst

* i18n
  docs/source/i18n.rst

* Management script
  docs/source/manage_py.rst

* Using Authentication
  docs/source/auth.rst

Online documentation
--------------------

* English
  http://kay-docs.shehas.net/

* Japanese
  http://kay-docs-jp.shehas.net/

Questions and Bug Report
------------------------

* Please visit Kay framework google group.
  http://groups.google.com/group/kay-users
  
* Or, contact the project leader directly.
  Takashi Matsuo <tmatsuo@candit.jp>

* Code site
  http://code.google.com/p/kay-framework/

Have fun!