Skip to content

Commit

Permalink
Updated README.asciidoc
Browse files Browse the repository at this point in the history
  • Loading branch information
gastaldi committed Aug 8, 2013
1 parent e04c5ab commit 282ab8f
Showing 1 changed file with 55 additions and 30 deletions.
85 changes: 55 additions & 30 deletions README.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ It is worth mentioning that the Eclipse plugin does not support access to shell

NOTE: The shell is not fully working at the moment, so we recommend you to use the Forge 2 Eclipse Plugin

- Download [JBoss Forge 2.0.0.Alpha9](https://repository.jboss.org/nexus/service/local/artifact/maven/redirect?r=releases&g=org.jboss.forge&a=forge-distribution&v=2.0.0.Alpha9&e=zip)
- Download link:https://repository.jboss.org/nexus/service/local/artifact/maven/redirect?r=releases&g=org.jboss.forge&a=forge-distribution&v=2.0.0.Alpha10&e=zip[JBoss Forge 2.0.0.Alpha10]
- Extract the ZIP to a folder and navigate to forge-2.0.0.Alpha9/bin folder

Forge is now ready to go.
Expand All @@ -42,7 +42,7 @@ Install the required addons by running the following commands:

- Forge will install the required dependencies for each addon.

If you wish to install the prototype Forge 2 Shell called Aesh, be sure to run the following:
If you wish to install the prototype Forge 2 Shell based on link:http://aeshell.github.io/[Aesh], be sure to run the following:

[source,cmd]
----
Expand All @@ -64,38 +64,61 @@ This plugin starts the Forge 2 Container and your installed addons, so you can u

- Press Ctrl + 5 to show the installed addons that you may interact with (these addons use the UI addon, hence providing a user interface - see Developing an UI Addon for more details).

== Available addons

=== The eclipse plugin already bundles the following addons
[options="header"]
|===
|Addon name |Included in Eclipse Plugin ?

- addon-manager
- convert
- dependencies
- environment
- facets
- javaee
- maven,projects
- resources
- ui
- ui-spi
|link:addon-manager/README.asciidoc[Addon Manager]
|yes

== Available addons
|link:addons/README.asciidoc[Addons]
|yes

|link:configuration/README.asciidoc[Configuration]
|yes

|link:convert/README.asciidoc[Convert]
|yes

|link:dependencies/README.asciidoc[Dependencies]
|yes

|link:environment/README.asciidoc[Environment]
|yes

|link:facets/README.asciidoc[Facets]
|yes

|link:javaee/README.asciidoc[Java EE]
|yes

- link:addon-manager/README.asciidoc[Addon Manager]
- link:addons/README.asciidoc[Addons]
- link:configuration/README.asciidoc[Configuration]
- link:convert/README.asciidoc[Convert]
- link:dependencies/README.asciidoc[Dependencies]
- link:environment/README.asciidoc[Environment]
- link:facets/README.asciidoc[Facets]
- link:javaee/README.asciidoc[Java EE]
- link:maven/README.asciidoc[Maven]
- link:parser-java/README.asciidoc[Parser - Java]
- link:projects/README.asciidoc[Projects]
- link:resources/README.asciidoc[Resources]
- link:scaffold/README.asciidoc[Scaffold]
- link:shell/README.asciidoc[Shell]
- link:ui/README.asciidoc[User Interface (UI)]
|link:maven/README.asciidoc[Maven]
|yes

|link:parser-java/README.asciidoc[Parser Java]
|yes

|link:projects/README.asciidoc[Projects]
|yes

|link:resources/README.asciidoc[Resources]
|yes

|link:scaffold/README.asciidoc[Scaffold]
|no

|link:shell/README.asciidoc[Shell]
|no

|link:stacks/README.asciidoc[Stacks]
|no

|link:ui/README.asciidoc[User Interface (UI)]
|yes

|===

== Developing an Addon

Expand Down Expand Up @@ -421,7 +444,7 @@ public class ExampleFurnaceTest {
}
----

Then you'll need to add some configuration so that your addon will be deployed to the test environmenet. This is done
Then you'll need to add some configuration so that your addon will be deployed to the test environment. This is done
using the `@AddonDependency` annotation. You'll also need to add an addon dependency link from your test case
to your addon (otherwise the test case will not be able to use any of your addon's classes or services.)

Expand Down Expand Up @@ -485,6 +508,8 @@ This is the basic premise of using the test-harness. For detailed examples, take
https://github.com/forge/core/tree/2.0/resources/tests/src/test/java/org/jboss/forge/addon/resource[look at some of the existing
Forge test cases] in our github repository.

NOTE: Since 2.0.0.Alpha10, the `version` parameter in `@AddonDependency` and in the `AddonDependencyEntry.create(...)` method are optional. By not specifying them means that the test harness
will attempt to find the version based on the tests' build descriptor (pom.xml). In this case, if the dependent addon is not present in the tests' build descriptor, the test execution should fail.

=== Install your addon in the local maven repository:

Expand Down

0 comments on commit 282ab8f

Please sign in to comment.