Skip to content

Commit

Permalink
new readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Richardson committed Jun 20, 2013
1 parent baa99e0 commit adc2222
Showing 1 changed file with 4 additions and 31 deletions.
35 changes: 4 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,42 +26,15 @@ For more information on Teiid Desginer, including getting started guides, refere
or follow us on our [blog](http://teiid.blogspot.com/) or on [Twitter](https://twitter.com/teiiddesigner). Or hop into our [IRC chat room](http://www.jboss.org/teiiddesigner/chat)
and talk our community of contributors and users.

## Get the code
## Hacking on the code

The easiest way to get started with the code is to [create your own fork](http://help.github.com/forking/) of this repository, and then clone your fork:

$ git clone git@github.com:<you>/teiiddesigner.git
$ cd teiiddesigner
$ git remote add upstream git://github.com/TeiidDesigner/teiiddesigner.git

At any time, you can pull changes from the upstream and merge them onto your master:

$ git checkout master # switches to the 'master' branch
$ git pull upstream master # fetches all 'upstream' changes and merges 'upstream/master' onto your 'master' branch
$ git push origin # pushes all the updates to your fork, which should be in-sync with 'upstream'

The general idea is to keep your 'master' branch in-sync with the 'upstream/master'.

## Building Teiid Designer

Then, we use Maven 3.x to build our software. The following command compiles all the code, installs the JARs into your local Maven repository, and run all of the unit tests:

$ mvn clean install -s settings.xml

BTW, that '-s settings.xml' argument uses the 'settings.xml' file in our codebase, which is set up to use the JBoss Maven repository.

That command takes a while -- we do have over 12K unit tests. So if need be, your builds can skip the tests:

$ mvn clean install -s settings.xml -DskipTests

If you have *any* trouble building (or don't like the '-s settings.xml' usage), check the [detailed build instructions and tips](http://community.jboss.org/wiki/TeiidDesignerAndMaven).
For getting the code, developing in Eclipse and building it using maven, please refer to this [article](https://community.jboss.org/wiki/SettingUpYourEclipseDevelopmentEnvironmentForTeiidDesigner80).

## Contribute fixes and features

ModeShape is open source, and we welcome anybody that wants to participate and contribute!
Teiid Designer is open source, and we welcome anybody that wants to participate and contribute!

If you want to fix a bug or make any changes, please log an issue in the [Teiid Designer JIRA](https://issues.jboss.org/browse/TEIIDDES) describing the bug
or new feature. Then we highly recommend making the changes on a topic branch named with the JIRA issue number. For example, this command creates
If you want to fix a bug or make any changes, please log an issue in the [Teiid Designer JIRA](https://issues.jboss.org/browse/TEIIDDES) describing the bug or new feature. Then we highly recommend making the changes on a topic branch named with the JIRA issue number. For example, this command creates
a branch for the TEIIDDES-1234 issue:

$ git checkout -b teiddes-1234
Expand Down

0 comments on commit adc2222

Please sign in to comment.