Merge pull request #4 from emmanuelbernard/documentation

Add doc on how to run GraalTest based tests from IDE
quarkusio · Aug 2, 2018 · 138f68a · 138f68a
2 parents e2d4e48 + a4f6471
commit 138f68a
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -2,11 +2,18 @@
 
 Examples exercising frameworks like Weld, Undertow etc using Shamrock as boot bed.
 
-## Strict
+## How to run them
+
+To run from your IDE tests inheriting from `GraalTest` (e.g. `@RunWith(GraalTest.class)`), you must define the `native.image.path` to the native image build of that specific example.
+For example: `-Dnative.image.path=/full/qualified/path/to/examples/example1/shamrock-test-deployment-1.0.0.Alpha1-SNAPSHOT`
+
+## List of examples
+
+### Strict
 
 Strict are exercising frameworks that do not require `-H:+ReportUnsupportedElementsAtRuntime`
 At the time of writing Weld needs it and thus is not in the strict category.
 
-## Everything
+### Everything
 
 Everything exercise all frameworks including the ones needing `-H:+ReportUnsupportedElementsAtRuntime`