Issue #974038 by mrlips: Current role not selected when editing rule
[project/uc_member_pricing.git] / README.txt
1
2 ********************************************************************************
3 ********************************************************************************
4
5 *****************
6 *  INFORMATION  *
7 *****************
8
9  Ubercart Member Pricing:  uc_member_pricing.module
10   
11 --------------------------------------------------------------------------------
12  DESCRIPTION
13   
14  Allows users with a "manage prices" role to specify per product price 
15  adjustments base on either user or role based rules.
16  
17  This price adjustment can be a specic price, a amount offset, or a percentage 
18  offset from the original price of the base product (not attribute products, 
19  which may already add their own amounts to the result of this modules price 
20  adjustment).
21  
22  It is important to consider the order of precedence when creating these rules.
23  
24  1. Role based pricing overrides the standard Ubercart "sell_price".  When a 
25                 user is a member of multiple roles with a specified pricing rule, then the
26                 lowest priced role price is used.
27                 
28  2. User based pricing overrides all role based rules. 
29  
30   
31  See the TODO.txt for known remaining tasks.  If you have ideas, let us know.
32
33 --------------------------------------------------------------------------------
34
35  maintained by:
36    * Brandon Williams http://drupal.org/user/615672
37
38
39  original sponsorship by:
40  
41    * Pop Design Works - [ http://popdw.com ]
42    * Stable Step Inc  - [ http://powersteps.com ]
43  
44  
45  original development by: 
46  
47    * CollectiveColors - http://collectivecolors.com
48      http://github.com/collectivecolors/drupal-modules-uc_member_pricing
49  
50  
51  project home: 
52
53    http://drupal.org/project/uc_member_pricing
54
55
56 ********************************************************************************
57 ********************************************************************************
58
59 ******************
60 *  INSTALLATION  *
61 ******************
62
63  Currently this module requires the following Drupal modules be installed
64  and enabled.
65  
66    * Ubercart  -  http://drupal.org/project/ubercart
67
68 --------------------------------------------------------------------------------
69  TO INSTALL VIA DRUPAL
70 --------------------------------------------------------------------------------
71
72  We highly recommend using drush if possible.  This will drastically speed up 
73  downloading and updating your Drupal packages.
74  
75    See http://drupal.org/project/drush
76    
77    
78  WITH DRUSH
79  
80    From your root Drupal site directory, run:
81    
82    
83    COMMAND_PROMPT$ drush dl uc_member_pricing
84    
85    
86    The to update, all you have to do is:
87    
88    
89    COMMAND_PROMPT$ drush update
90    
91    
92    This will update any contributed projects that have new releases.  This is
93    much better than downloading the packages yourself.  Oh, drush is extensible
94    as well, so you can write your own drush modules.
95    
96    
97  WITHOUT DRUSH
98  
99    Go download the recommended package from the drupal project page.  Untar in
100    your sites/all/modules folder or wherever you are putting your modules.   
101    
102 --------------------------------------------------------------------------------
103  TO INSTALL VIA GIT
104 --------------------------------------------------------------------------------
105  START BY:
106
107  [1]$ cd $TOP_LEVEL_SITE_DIRECTORY
108  
109  -------------------------------------------
110 |  To clone this module into a Drupal site  |
111  -------------------------------------------
112   THEN DO THIS:
113  
114    # Only if your Drupal project << IS NOT >> a GIT REPOSITORY!!!
115  
116  [2]$ git clone --branch 6.x-1.x http://git.drupal.org/project/uc_member_pricing.git 
117                 sites/all/modules/uc_member_pricing
118
119  --------------------------------------------
120 |  To import this module as a Git submodule  |
121  --------------------------------------------
122   OR DO THIS:
123   
124    # Only if your Drupal project << IS >> a GIT REPOSITORY!!!
125               
126  [2]$ git submodule add -b 6.x-1.x http://git.drupal.org/project/uc_member_pricing.git
127                         sites/all/modules/uc_member_pricing
128                         
129  [2.1]$ git commit -m "Adding uc_member_pricing module to project."
130
131 ---------------------------------------------
132  THEN CONTINUE WITH:
133  
134  [3]$ cd sites/all/modules/uc_member_pricing
135           
136  [4]$ git checkout -b $MY_BRANCH $MODULE_TAG   
137     
138     # For example, $MY_BRANCH  = 6.x-1.x
139     # For example, $MODULE_TAG = 6.x-1.0-beta1
140       
141  [5]$ git status # Your ready for site configuration ( See below )
142
143
144 ********************************************************************************
145 ********************************************************************************
146
147 *******************
148 *  CONFIGURATION  *
149 *******************
150
151 1. Go to the administration page, [ /admin/user/permissions ], and find the 
152    section for the "uc_member_pricing module".  Set which roles are able to 
153    administer special user or role based pricing at your site.  Not that these
154    users can change the price of any product on the site.
155    
156 2. Create your products.
157
158 3. After you have created your products, you will see a new tab under the node
159    edit page, called "Prices". Go there an start creating your rules.  Follow
160    the instructions on the rule add or edit form.  These rules become active for
161    the users and roles that they apply to on that page.
162
163 4. Let us know if you have problems.  Use the issue queue at:
164
165   http://drupal.org/project/issues/uc_member_pricing
166   
167   * Please post any issues you have with this module there.
168
169
170 ********************************************************************************
171 ********************************************************************************