Updated instructions for contributing, added dependencies

django-oscar · Jan 25, 2012 · 8d34321 · 8d34321
1 parent df8ea01
commit 8d34321
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -12,6 +12,29 @@ sites to complex B2B sites rich in domain-specific business logic.
 
 .. _`Read the docs`: http://django-oscar.readthedocs.org/en/latest/
 
+Quick start
+-----------
+
+After forking, do the following::
+
+    mkvirtualenv oscar
+    git clone git@github.com/<username>/django-oscar.git
+    cd django-oscar
+    python setup.py develop
+    pip install -r testing-reqs.txt
+
+You can run the test suite using::
+
+    ./run-tests.py
+
+You can browse a "sandbox" shop by doing the following::
+
+    cd sandbox
+    ./manage.py syncdb --noinput
+    ./manage.py import_catalogue data/books-catalogue.csv
+    ./manage.py import_images data/book-images.tar.gz
+    ./manage.py runserver
+
 Credits
 -------
 

diff --git a/sandbox/settings.py b/sandbox/settings.py
@@ -224,9 +224,7 @@
 
 # Haystack settings
 HAYSTACK_SITECONF = 'oscar.search_sites'
-HAYSTACK_SEARCH_ENGINE = 'solr'
-HAYSTACK_SOLR_URL = 'http://127.0.0.1:8080/solr'
-HAYSTACK_INCLUDE_SPELLING = True
+HAYSTACK_SEARCH_ENGINE = 'dummy'
 
 # Oscar settings
 from oscar.defaults import *

diff --git a/setup.py b/setup.py
@@ -24,6 +24,8 @@
       platforms=['linux'],
       packages=find_packages(exclude=["*.tests"]),
       install_requires=[
+          'django>=1.3',
+          'PIL',
           'django-extra-views>=0.1.0',
           'django-haystack>=1.2.0',
           'django-treebeard>=1.6.1',