diff --git a/README.rst b/README.rst index 400114e..4947a1e 100644 --- a/README.rst +++ b/README.rst @@ -10,9 +10,9 @@ is created. Use this project with Django 1.4's ``startproject`` command:: - django-admin.py startproject --template=https://github.com/tangentlabs/tangent-django-boilerplate/zipball/master + django-admin.py startproject $PROJECT_NAME --template=https://github.com/tangentlabs/tangent-django-boilerplate/zipball/master -Note that you need to pass the following variables: +Note that you need to specify a name for the project and pass the following variables: * ``client`` - The client for this project @@ -22,6 +22,14 @@ Note that you need to pass the following variables: * ``timezone`` - Which timezone to use in ``settings.py`` +Tangent developers can use the `tangent-kickstart`_ tool to simplify creation +of projects that conform to our conventions: + +.. _`tangent-kickstart`: https://github.com/tangentlabs/tangent-kickstart + +The below copy will contains template variables - it gets merged with a context +when a new boilerplate project is created. + ======================================= {{ client|title }} / {{ project_code }} =======================================