Skip to content

Commit

Permalink
Add help and readme for into project
Browse files Browse the repository at this point in the history
  • Loading branch information
bradwright committed Nov 15, 2008
1 parent 9491ca7 commit 55677c9
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.markdown
@@ -1,4 +1,27 @@
Django Layout
=============

Intended as a nice default starting point for Django, including deployment server configs. Essentially replaces `django-admin.py startproject [THING]`.
Intended as a nice default starting point for Django, including deployment server configs. Essentially replaces `django-admin.py startproject [THING]`.

Project Naming
--------------

Obviously the `.git` objects are included when checking out from GitHub, so you should copy the appropriate directories to somewhere Git-free (if you want):

$ cp -r !(.git) ../mynewdjangoproject

By default it comes named as `yoursite`, but you should obviously name it yourself:

$ mv yoursite mydomain

Python Path
------------

`manage.py` automatically patches your sys.path to include files under `lib`, so you can feel free to put Python modules here:

$ svn co http://.../mymodule.py lib/.
# inside a Python file in your Django project
import mymodule
# just works!

This allows you to bundle your own library modules or external dependencies (dmigrations, simplejson etc.) with your project as required. It also means that a checkout to a plain Python system should Just Work™.
4 changes: 4 additions & 0 deletions lib/README.markdown
@@ -0,0 +1,4 @@
Django Lib
==========

This directory is automatically included in your Python path, so feel free to add external files into here for use in your project.

0 comments on commit 55677c9

Please sign in to comment.