Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Add a readme file for this app

  • Loading branch information...
commit e7f48f89543e0f2d8ebad79815466b3e2e867fbd 1 parent 3d53376
Chris Beaven authored ipmb committed

Showing 1 changed file with 48 additions and 0 deletions. Show diff stats Hide diff stats

  1. +48 0 README
48 README
... ... @@ -0,0 +1,48 @@
  1 +============
  2 +StartProject
  3 +============
  4 +
  5 +StartProject installs a script which allows the easy creation of a standard
  6 +Django project layout based on Lincoln Loop standards.
  7 +
  8 +
  9 +Script usage
  10 +============
  11 +
  12 +After installing StartProject, simply run the following command (from within
  13 +the directory in where the new project directory should be created)::
  14 +
  15 + django-startproject.py project_name
  16 +
  17 +The script will prompt for values to replace boilerplate variables with. These
  18 +variables allow for both the file contents and path names to be customized to
  19 +this specific project.
  20 +
  21 +
  22 +Using a custom project template
  23 +===============================
  24 +
  25 +If you would prefer to use a custom project template than the one included in
  26 +this application, create your custom project template directory and call the
  27 +command script like this::
  28 +
  29 + django-startproject.py --template-dir=/your/custom/template project_name
  30 +
  31 +
  32 +Specifying boilerplate variables
  33 +--------------------------------
  34 +
  35 +Two optional files in the root of the project template directory are used to
  36 +determine the boilerplate variables:
  37 +
  38 +``.startproject_boilerplate``
  39 + Each line should contain the boilerplate variable (and optionally, a
  40 + description of the variable, separated from the variable by white space).
  41 +
  42 +``.startproject_defaults``
  43 + Each line should contain a variable and the default value, separated by
  44 + whitespace. If the default value contains ``PROJECT``, it is replaced with
  45 + the project name.
  46 +
  47 +See the files included in the project_template directory of StartProject for
  48 +an example.

0 comments on commit e7f48f8

Please sign in to comment.
Something went wrong with that request. Please try again.