Skip to content

Commit e2809cf

Browse files
committed
Updated Readme to use 3.0 as the example
1 parent f025b39 commit e2809cf

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,11 @@ business users to dynamically drive the most appropriate content to users.
106106

107107
Broadleaf Commerce recommends JDK 1.7, but will build/run with JDK 1.6 or 1.7. At this time Broadleaf has not been tested with Java 8.
108108

109-
The easiest way to get the Broadleaf framework locally set up with the DemoSite is to clone this repository and execute a clean install via Maven:
109+
Most developers won't need to modify the framework code and instead should rely on the [Getting Started guide](http://docs.broadleafcommerce.org/current/Getting-Started.html) to quickly kick off your Broadleaf-enabled website.
110+
111+
If you do want to fix a bug or contribute to Broadleaf, see our [CONTRIBUTING.md](CONTRIBUTING.md) guidelines.
112+
113+
The easiest way to make changes to the core framework (again not typical) is to clone this repository and execute a clean install via Maven:
110114

111115
```sh
112116
mvn clean install
@@ -126,21 +130,18 @@ mvn clean install -Pblc-development -DskipTests
126130

127131
> Note: all contributed code must have passing tests via Maven
128132
129-
If you need to use a specific version of Broadleaf, simply check out that version using either the branch or tag. All releases are tagged 'broadleaf-<version>' whereas all active development versions are tagged 'BroadleafCommerce-<major.minor>.x'. For instance, if you would like to actively develop on the Broadleaf 2.2 line in order for your changes to be in the next GA patch release of Broadleaf 2.2, you would check out the 'BroadleafCommerce-2.2.x' branch.
133+
If you need to use a specific version of Broadleaf, simply check out that version using either the branch or tag. All releases are tagged 'broadleaf-<version>' whereas all active development versions are tagged 'BroadleafCommerce-<major.minor>.x'. For instance, if you would like to actively develop on the Broadleaf 3.0 line in order for your changes to be in the next GA patch release of Broadleaf 3.0, you would check out the 'BroadleafCommerce-3.0.x' branch.
130134

131135
```sh
132136
git clone [email protected]:BroadleafCommerce/BroadleafCommerce
133137
cd BroadleafCommerce
134138

135-
# use 2.2.x-SNAPSHOT
136-
git checkout BroadleafCommerce-2.2.x
137-
mvn clean install -Pblc-development
138-
139-
# switch to a GA version
140-
git checkout broadleaf-2.2.0-GA
139+
# use 3.0.x-SNAPSHOT
140+
git checkout BroadleafCommerce-3.0.x
141141
mvn clean install -Pblc-development
142142
```
143143

144+
144145
## Contributing
145146
See [CONTRIBUTING.md](CONTRIBUTING.md)
146147

0 commit comments

Comments
 (0)