Anonymous avatar Anonymous committed d260a99

Text update

Comments (0)

Files changed (2)

 django-environments
 ===================
 
-Manage different settings for different locations (machines), or
-Fabric's 'roles', like local (your machine), development (shared
-development system), test, staging/acceptance and production.
+Manage different settings for different locations (systems), like
+local (your machine), development (shared development system), test,
+staging/acceptance and production.
+
+Or, more generically: be able to refactor your settings as you like,
+by simply "inheriting" from more generic settings using 'from ...
+import'.
 
 Compatibility with virtualenv
 ==============================
 Getting Started
 ===============
 
-This is a fully working Django project. You can copy files from it
-as needed to your own projects.
+This is a fully working Django project; you can copy files from it
+as needed to your own projects. To get django-environments working
+by itself, do the following:
 
  1. Copy scripts/initenv_example to scripts/initenv.
  2. Edit initenv and set ``PROJECT_ROOT``, ``DJANGO_PROJECT`` (always a
     subdirectory of ``PROJECT_ROOT``) and ``PROJECT_SETTINGS``.
  3. Activate the environment using ``source scripts/initenv``.
- 4. When using virtualenv with virtualenvwrapper, you can do 
-    ``source <path-to-project>/scripts/initenv`` from ``bin/postactivate``.
+ 4. When using virtualenv with virtualenvwrapper, you can do either
+    ``source <path-to-project>/scripts/initenv`` from ``bin/postactivate``,
+    or simply use your initenv's contents inside postactivate.
 
 If everything works okay, the following shell aliases are created:
 
 Using Apache mod_wsgi
 =====================
 
-Copy the mysite/deploy/example.wsgi to mysite/deploy/local.wsgi,
+Should you wish to use the local settings in settings/env/local.py,
+simply copy the mysite/deploy/example.wsgi to mysite/deploy/local.wsgi,
 and add something like this to your httpd.conf::
 
     WSGIPythonHome /Users/.virtualenvs/django-environments # Optional
 ===========
 
  * The ``mysite/settings`` directory replaces ``settings.py`` and contains
-   the default settings in ``generic.py``, which is imported in ``__init__.py``.
+   the default settings in ``generic.py``, whose contents are
+   imported in ``__init__.py``.
  * The ``mysite/settings/env`` directory contains the different settings
    files for every environment.
- * All .wsgi files in the ``mysite/deploy`` folder are equal; their
-   respective filenames are used to determine which settings to import.
+ * All .wsgi files in the ``mysite/deploy`` folder are normally
+   equal; their respective filenames are used to determine which
+   settings to import.
  * As discussed above, the scripts directory contains the shell
    scripts intended to be sourced with the ``source`` command.
 

scripts/initenv_generic

-# Set the following variables in your bin/postactivate, then source this file
+# It's best to set the following variables in your own initenv or
+# bin/postactivate, and then source this file
 
 # The root of the project, i.e. the directory containing your Django project
 #PROJECT_ROOT=/Users/joe/projects/myproject
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.