-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Ian Anderson
committed
May 24, 2012
1 parent
73397d9
commit 3a6e8c6
Showing
1 changed file
with
62 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
============== | ||
Using ZopeSkel | ||
============== | ||
|
||
Installing ZopeSkel | ||
=================== | ||
|
||
ZopeSkel can be installed in one of two ways: with `buildout | ||
<http://www.buildout.org/>`_ or with `virtualenv <http://virtualenv.org/>`_. | ||
|
||
.. note :: | ||
Despite existing documentation to the contrary, it is not recommended to | ||
install ZopeSkel in your system python. | ||
Buildout installation | ||
--------------------- | ||
|
||
Add to your ``buildout.cfg``:: | ||
|
||
parts = | ||
... | ||
zopeskel | ||
|
||
[zopeskel] | ||
# installs paster and Zopeskel | ||
recipe = zc.recipe.egg | ||
eggs = | ||
PasteScript | ||
ZopeSkel | ||
|
||
After re-running buildout, you will have ``zopeskel`` and ``paster`` commands in | ||
the ``bin`` directory of your buildout. | ||
|
||
Virtualenv installation | ||
----------------------- | ||
|
||
First, install virtualenv into your system:: | ||
|
||
easy_install virtualenv | ||
|
||
Next, create a virtual environment with the new ``virtualenv`` command:: | ||
|
||
virtualenv --distribute zopeskelenv | ||
|
||
Once virtualenv has finished creating your new virtual environment, you can | ||
install zopeskel to your new virtual environment by:: | ||
|
||
zopeskelenv/bin/easy_install zopeskel | ||
|
||
Once this is complete, you will have ``zopeskel`` and ``paster`` commands in the | ||
``bin`` directory of your virtualenv. | ||
|
||
|
||
Basic Usage | ||
----------- | ||
|
||
|
||
You can use zopeskel to add new projects to your buildout ``src/`` folder. | ||
|
||
|
||
|