From c99a2856801eaf6088d1d2f8a6ad70d8adc3a0d6 Mon Sep 17 00:00:00 2001 From: Noah Zoschke Date: Wed, 18 May 2011 10:14:12 -0700 Subject: [PATCH] readme polish --- Readme.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/Readme.md b/Readme.md index 4b7893a..e98181a 100644 --- a/Readme.md +++ b/Readme.md @@ -6,7 +6,7 @@ apps on Heroku. If `requirements.txt` is present, the PLP considers the directory a Python app with packages to install via pip. -Furthermore, if `${project}/settings.py` is present, the PLP considers the +Furthermore, if `${PROJECT}/settings.py` is present, the PLP considers the directory a Python/Django app, and patches `settings.py` to parse the Heroku DATABASE_URL config vars. It then sets default process types to use the Django web server and console. @@ -17,17 +17,17 @@ The PLP uses a Makefile for user-controlled hooks into slug compilation. If present, the `make environment` rule will be eval'd in the compile script, allowing user-defined exports. -A sample Makefile to force a re-build of every pip package is: +A sample Makefile +(raw) +to force a re-build of every pip package is: environment: export PIP_OPTS=--upgrade -(raw file) - Django settings.py ------------------ -The PLP injects code into settings.py to alias every Heroku database URL -config var. Every variable of the format ${NAME}_URL => postgres:// will be +The PLP injects code into `settings.py` to alias every Heroku database URL +config var. Every variable of the format `${NAME}_URL => postgres://` will be added to the settings.DATABASES hash. On an app with both a shared SHARED_DATABASE_URL and a dedicated @@ -41,4 +41,4 @@ like: 'default': {'ENGINE': 'psycopg2', 'NAME': 'dedicated', ...}, } -These aliases can be referenced and further modified at the end of the settings file. +These aliases can be referenced and further modified at the bottom of `settings.py`.