Skip to content

Commit f004561

Browse files
committed
update readme to describe gradle activities
1 parent a947b1e commit f004561

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

README.md

+16-11
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
1-
JavaParser and Maven sample
1+
JavaParser and Gradle sample
22
---
33

4-
A fully working sample Maven project that parses and generates code with [JavaParser](http://www.javaparser.org)
4+
A fully working sample Gradle project that parses and generates code with [JavaParser](http://www.javaparser.org)
55

6-
This is targeted at people without [Maven](https://maven.apache.org/) experience.
6+
This is targeted at people without [Gradle](https://gradle.org/) experience.
7+
8+
To build it, you will need to download and unpack the latest (or recent) version of Gradle (https://gradle.org/install/)
9+
and put the `gradle` command on your path. Alternatively, you can use the (included) gradle wrapper.
710

8-
To build it, you will need to download and unpack the latest (or recent) version of Maven (https://maven.apache.org/download.cgi)
9-
and put the `mvn` command on your path.
1011
Then, you will need to install a Java 1.8 (or higher) JDK (not JRE!), and make sure you can run `java` from the command line.
11-
Now you can run `mvn clean install` and Maven will compile your project,
12-
an put the results it in two jar files in the `target` directory.
13-
If you like to run from the command line,
14-
execute `java -jar target/javaparser-maven-sample-1.0-SNAPSHOT-shaded.jar`.
1512

16-
How you run this code is up to you, but usually you would start by using an IDE like [NetBeans](https://netbeans.org/), [Intellij IDEA](https://www.jetbrains.com/idea/), or [Eclipse](https://eclipse.org/ide/).
13+
Now you can run `gradle shadowJar` - Gradle will compile your project and put the
14+
resulting jar file in the `build` directory.
15+
16+
If you like to run from the command line, execute
17+
`java -jar build/libs/javaparser-gradle-sample-shadow-1.0-SNAPSHOT-beta.jar`.
18+
19+
How you run this code is up to you, but usually you would start by using an IDE
20+
like [NetBeans](https://netbeans.org/), [Intellij IDEA](https://www.jetbrains.com/idea/),
21+
or [Eclipse](https://eclipse.org/ide/).
1722

18-
The Maven dependencies may lag behind the official releases a bit.
23+
Note that the JavaParser dependencies may lag behind the official releases a bit.
1924

2025
If you notice some problems with this setup, please open an issue.

0 commit comments

Comments
 (0)