Ver código fonte

Rewrote README.md a little, and updated requirements

master
David Winterbottom 15 anos atrás
pai
commit
b5b73b4458
2 arquivos alterados com 14 adições e 10 exclusões
  1. 14
    9
      README.md
  2. 0
    1
      requirements-dev.txt

+ 14
- 9
README.md Ver arquivo

@@ -1,8 +1,8 @@
1 1
 # Django-Oscar - Flexible e-commerce on Django
2 2
 
3 3
 Named after [Oscar Peterson](http://en.wikipedia.org/wiki/Oscar_Peterson),
4
-django-oscar is a flexible ecommerce platform, structured to allow accurate
5
-domain models to be constructed.  It is not supposed to be a framework that can
4
+django-oscar is a flexible ecommerce platform, designed to build domain-driven
5
+ecommerce sites to be constructed.  It is not supposed to be a framework that can
6 6
 be downloaded and fully set up by simply adjusting a configuration file: there
7 7
 will always be some developer work required to make sure the models match those
8 8
 from your domain - this is the nature of domain modelling.
@@ -16,15 +16,17 @@ is a pleasure to work with and maintain.
16 16
 
17 17
 * To be a portable Django application that provides ecommerce functionality.  
18 18
 * To comprise a set of loosely coupled apps that can be overridden in projects (interdependence is on interfaces only)
19
-* To allow core objects (eg products, orders) to be extended within a specific project
19
+* To be highly customisable so any part of the core can be customised.
20 20
 
21 21
 The central aim is to provide a solid core of an ecommerce project that can be
22 22
 extended and customised to suit the domain at hand.  One way to acheive this is
23 23
 to have enormous models that have fields for every possible variation; however,
24
-this is unwieldy and ugly.  A more elegant solution is to have models where all
25
-the fields are meaningful within the ecommerce domain.  In general, this means
26
-more work up front in terms of creating the right set of models but leads
27
-ultimately to a much cleaner and coherent system.
24
+this is unwieldy and ugly.  
25
+
26
+A more elegant solution is to have minimal models where all the fields are meaningful
27
+within any ecommerce domain.  In general, this means more work up front in
28
+terms of creating the right set of models but leads ultimately to a much
29
+cleaner and coherent system.
28 30
 
29 31
 ## Core design decisions
30 32
 
@@ -148,9 +150,12 @@ After checking out your fork, install the latest version of Django into your vir
148 150
 
149 151
 Clone this repository to get the latest version of Oscar
150 152
 
151
-Install all packages from the requirements file
153
+Install all packages from the requirements file (optional)
152 154
 
153
-	pip install -r requirements.txt
155
+	pip install -r requirements-dev.txt
156
+
157
+This just provides some useful tooling for developing a django project - the installed
158
+modules are not mandatory to run oscar.
154 159
 
155 160
 Install oscar in development mode within your virtual env
156 161
 

+ 0
- 1
requirements-dev.txt Ver arquivo

@@ -5,4 +5,3 @@ django-extensions==0.5
5 5
 ipdb==0.2
6 6
 ipython==0.10.1
7 7
 wsgiref==0.1.2
8
-PIL==1.1.7

Carregando…
Cancelar
Salvar