Recursive clone to check out initially. To start project, fork and branch to master.

This commit is contained in:
Fred Wenzel 2011-01-03 15:54:18 -08:00
Родитель 3d414adc78
Коммит f1445eaa32
1 изменённых файлов: 19 добавлений и 4 удалений

Просмотреть файл

@ -9,15 +9,18 @@ Patches are welcome! Feel free to fork and contribute to this project on
[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. After
checkout, run:
To check out playdoh, run:
git submodule update --init --recursive
git clone --recursive git://github.com/mozilla/playdoh.git
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. The recursive
checkout will also clone these requirements.
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
@ -33,6 +36,18 @@ For more information on vendor libraries, read [Packaging in Zamboni][packaging]
[packaging]: http://jbalogh.github.com/zamboni/topics/packages/
[virtualenv]: http://pypi.python.org/pypi/virtualenv
Starting a project based on playdoh
-----------------------------------
The default branch of playdoh is ``base``. To start a new project, you fork
playdoh and start working on your app in ``master`` (branched from base). If
you start adding pieces that should go back into playdoh, you can apply the
patch to base and move it upstream.
Eventually you'll probably diverge enough that you'll want to delete the base
branch.
License
-------
This software is licensed under the [New BSD License][BSD]. For more