Skip to content

Commit 25d64c3

Browse files
committed
Add a section in the documentation about running the example from the command line.
1 parent 1b5326c commit 25d64c3

File tree

2 files changed

+12
-19
lines changed

2 files changed

+12
-19
lines changed

core-examples/README.adoc

+12
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,18 @@ Vert.x core provides fairly low level functionality for a diverse range of funct
66
WebSockets, file system access, timers, verticles and more. Please consult the Vert.x core manual for detailed
77
documentation on Vert.x core.
88

9+
10+
Examples can be run directly from the IDE by executing the `main` method. Alternatively, you can run them using the
11+
`vertx` command line tool (that need to be installed beforehand):
12+
13+
```
14+
mvn clean compile
15+
vertx run fully-qualified-name-of-the-example -cp target/classes
16+
```
17+
18+
Adapt the `-cp` option value for your current working directory and operating system.
19+
20+
921
== Dependencies required
1022

1123
To use Vert.x core in your own Maven or Gradle project add the following dependency

core-examples/pom.xml

-19
Original file line numberDiff line numberDiff line change
@@ -47,25 +47,6 @@
4747
</plugin>
4848
</plugins>
4949
</pluginManagement>
50-
<plugins>
51-
<plugin>
52-
<!-- copy dependencies to ease the usage of the vertx command line -->
53-
<artifactId>maven-dependency-plugin</artifactId>
54-
<version>2.10</version>
55-
<executions>
56-
<execution>
57-
<id>copy-dependencies</id>
58-
<goals>
59-
<goal>copy-dependencies</goal>
60-
</goals>
61-
<phase>verify</phase>
62-
<configuration>
63-
<outputDirectory>${project.build.directory}/dependencies</outputDirectory>
64-
</configuration>
65-
</execution>
66-
</executions>
67-
</plugin>
68-
</plugins>
6950
</build>
7051

7152

0 commit comments

Comments
 (0)