Skip to content

Commit

Permalink
merge readme.md, fix relative path, set relativepath to avoid mvn war…
Browse files Browse the repository at this point in the history
…ning
  • Loading branch information
maxandersen authored and pmuir committed Jul 22, 2011
1 parent db52778 commit bbae3aa
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 18 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
*~
.classpath
.project
target
Expand Down
12 changes: 0 additions & 12 deletions README-development.md

This file was deleted.

15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
JBoss AS Quickstarts
JBoss AS Quickstarts
====================

This project contains sources for the JBoss AS Quickstarts:
Quickstarts (or examples, or samples) for JBoss AS. There are a number of rules for quickstarts:

* `quickstarts/` -- sources for the examples discussed in the JBoss AS Documentation
* `dist/` -- maven script to build a zip of the quickstarts
* Each quickstart should have a unique name, this enables a user to quickly identify each quickstart
* A quickstart should have a simple build that the user can quickly understand. If using maven it should:
1. Not inherit from another POM
2. Import the various BOMs from AS7 APIs to get version numbers
3. Use the JBoss AS Maven Plugin to deploy the example
* The quickstart should be importable into JBoss Tools and deployable there
* The quickstart should be explained in detail in the associated user guide, including how to deploy

You can find the documentation at <https://docs.jboss.org/author/display/AS7/Documentation>.

If you add a quickstart, don't forget to update `dist/src/main/assembly/README.md`.

The 'dist' folder contains Maven scripts to build a zip of the quickstarts.
1 change: 1 addition & 0 deletions dist/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
<groupId>org.jboss</groupId>
<artifactId>jboss-parent</artifactId>
<version>6-beta-2</version>
<relativePath/>
</parent>
<groupId>org.jboss.as.quickstarts</groupId>
<artifactId>jboss-as-quickstarts-dist</artifactId>
Expand Down
5 changes: 3 additions & 2 deletions dist/src/main/assembly/assembly.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,15 @@
</includes>
</fileSet>
<fileSet>
<directory>${project.basedir}/../quickstarts</directory>
<directory>${project.basedir}/..</directory>
<outputDirectory>/</outputDirectory>
<excludes>
<exclude>dist</exclude>
<exclude>**/target/**</exclude>
<exclude>**/.project</exclude>
<exclude>**/.settings/**</exclude>
<exclude>**/.classpath</exclude>
<exclude>**/README-development.md</exclude>
<exclude>**/README.md</exclude>
</excludes>
</fileSet>
</fileSets>
Expand Down

0 comments on commit bbae3aa

Please sign in to comment.