activemq-artemis/README.md

35 lines
1.1 KiB
Markdown
Raw Normal View History

2015-04-21 09:49:05 -04:00
# ActiveMQ Artemis
2015-05-13 13:49:42 -04:00
This file describes some minimum 'stuff one needs to know' to get started coding in this project.
## Source
2015-05-13 13:49:42 -04:00
For details about the modifying the code, building the project, running tests, IDE integration, etc. see
our [Hacking Guide](./docs/hacking-guide/en/SUMMARY.md).
## Examples
To run an example firstly make sure you have run
2015-05-13 13:49:42 -04:00
$ mvn -Prelease install
If the project version has already been released then this is unnecessary.
then you will need to set the following maven options, on Linux by
2015-05-13 13:49:42 -04:00
$ export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=512m"
and the finally run the examples by
2015-05-13 13:49:42 -04:00
$ mvn verify
You can also run individual examples by running the same command from the directory of which ever example you want to run.
NB for this make sure you have installed examples/common.
### Recreating the examples
If you are trying to copy the examples somewhere else and modifying them. Consider asking Maven to explicitly list all the dependencies:
2015-05-13 13:49:42 -04:00
# if trying to modify the 'topic' example:
cd examples/jms/topic && mvn dependency:list