Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add help and readme for into project
- Loading branch information
1 parent
9491ca7
commit 55677c9
Showing
2 changed files
with
28 additions
and
1 deletion.
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 |
---|---|---|
@@ -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™. |
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,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. |