Permalink
Browse files

Updated README documentation

  • Loading branch information...
1 parent 229de22 commit 161b5d6a4b30ad03f9e1b4c4435f4e64076114ad @brosner brosner committed Aug 18, 2012
Showing with 14 additions and 17 deletions.
  1. +14 −17 README.rst
View
@@ -8,42 +8,39 @@ Gondor. You can use this to start your project that will be hosted on Gondor.
Usage
=====
-Use the files here to start your own project. To make this project runnable
-you will need to install its dependencies in your environment (ideally you
-create a virtual environment with `virtualenv`_.)
+Create a virtual environment (see `virtualenv`_) and install Django::
-::
+ pip install Django==1.4.1
- pip install -r requirements.txt
+Now you are ready to start your Django project. Use ``startproject`` to get
+this template.
+
+::
-Now, you will likely want to customize the naming to better match your
-actual project.
+ django-admin.py startproject --template=https://github.com/eldarion/gondor-project-django/zipball/master --extension=py,yml <project_name>
+ cd <project_name>
-``project_name`` is the Python package. You will want to rename this and
-every where ``project_name`` appears in the code base. This includes:
+To make this project runnable you will need to install its dependencies in
+your virtual environment.
- * ``manage.py`` and ``wsgi.py`` when setting ``DJANGO_SETTINGS_MODULE``
- in ``setdefault``
- * ``settings.py`` when setting ``ROOT_URLCONF`` and ``WSGI_APPLICATION``
- * ``gondor.yml`` for ``wsgi.entry_point`` and ``env.DJANGO_SETTINGS_MODULE``
+::
-When you initialize your version control system be sure to do this in the
-directory containing ``project_name`` (the Python package.)
+ pip install -r requirements.txt
You are now ready to deploy this project to Gondor!
If you use git::
git init
git add .
- git commit -m "initial project layout"
+ git commit -m "Initial project layout"
gondor deploy primary master
If you use mercurial::
hg init
hg add .
- hg commit -m "initial project layout"
+ hg commit -m "Initial project layout"
gondor deploy primary default
.. _virtualenv: http://www.virtualenv.org/

0 comments on commit 161b5d6

Please sign in to comment.