Skip to content

Commit

Permalink
added a readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Fred Wenzel committed Dec 28, 2010
1 parent 88cbf13 commit c897a5c
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
@@ -0,0 +1,36 @@
playdoh
=======

Mozilla's Playdoh is a web application template based on [Django][django].

Patches are welcome! Feel free to fork and contribute to this project on
[github][gh-playdoh].

[django]: http://www.djangoproject.com/
[gh-playdoh]: https://github.com/mozilla/playdoh

Requirements
------------
You need Python 2.6.

This project is set up to use a vendor library, i.e. a subdirectory ``vendor``
that contains all pure Python libraries required by this project.

In addition, there are compiled libraries (such as Jinja2) that you will need
to build yourself, either by installing them from ``pypi`` or by using your
favorite package manager for your OS.

For development, you can run this in a [virtualenv environment][virtualenv]:

easy_install pip
pip install -r requirements/compiled.txt

[virtualenv]: http://pypi.python.org/pypi/virtualenv

License
-------
This software is licensed under the [New BSD License][BSD]. For more
information, read the file ``LICENSE``.

[BSD]: http://creativecommons.org/licenses/BSD/

0 comments on commit c897a5c

Please sign in to comment.