Commit 97b1a1e0 authored by Jim Fulton's avatar Jim Fulton

Added some basic install instructions.

parent 37bce56b
...@@ -51,3 +51,45 @@ Buildout is a project designed to solve 2 problems: ...@@ -51,3 +51,45 @@ Buildout is a project designed to solve 2 problems:
To learn more about buildout, including how to use it, see To learn more about buildout, including how to use it, see
http://buildout.org/. http://buildout.org/.
Installation
************
There are a number of ways to install buildout. You can install it as
you would any other package, using pip or easy_install. In this case,
you'll get a buildout command that you can use to build projects. To
build a project, just use::
buildout
from a project directory.
Buildout's (stubborn) philosophy, however, is that projects should be
self-contained, and not require changes to a shared Python
installation. To avoid changing a shared Python installation you can
download a bootstrap script that, when run, will install buildout
locally in your project.
The bootstrap script for buildout version 2 is at:
http://downloads.buildout.org/2/bootstrap.py
So, for example, to install buildout 2 in a project, you might::
wget http://downloads.buildout.org/2/bootstrap.py
python bootstrap.py
Then to build your project, you can just run::
bin/buildout
from the project directory.
The bootstrap script is often checked into version control.
buildout 2 is somewhat backward-incompatible with version 1. Most
projects will probably work fine with either. If you need to keep
using version 1, however, specify a version requirement when you use
pip or easy_install, or use the version 1 bootstrap script at:
http://downloads.buildout.org/1/bootstrap.py
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment