Skip to content

Commit 95dcb07

Browse files
DSouzaMdnestoro
authored andcommitted
Polish developer documentation
1 parent 8bf738f commit 95dcb07

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

DEVELOPING.md

+7-10
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# Documentation for Developers
22

3-
This document describes how to set up and develop native-build-tools on your local machine.
3+
This document describes how to set up and develop Native Build Tools on your local machine.
44

55
## Environment
66

77
The project uses Gradle as its build system. At the very minimum, you should set `JAVA_HOME` to a [Gradle-compatible JDK](https://docs.gradle.org/current/userguide/compatibility.html).
88

99
Some build tasks require a GraalVM JDK (e.g., tests). You should set `GRAALVM_HOME` to an appropriate GraalVM JDK.
1010

11-
## IDE setup
11+
## IDE Setup
1212

13-
The native-build-tools repo is set up as a multi-project Gradle project, with the Maven and Gradle plugins declared as subprojects of the root project.
13+
The Native Build Tools repo is set up as a multi-project Gradle project, with the Maven and Gradle plugins declared as subprojects of the root project.
1414
To set the project up in your IDE (e.g., IntelliJ IDEA), import the root project and the IDE should automatically import the subprojects.
1515

16-
## Building & testing
16+
## Building and Testing
1717

1818
You can use the various commands in the [Gradle build lifecycle](https://docs.gradle.org/current/userguide/build_lifecycle.html) to build and test the project.
1919
Some examples (all executed from the root of the repository):
@@ -30,7 +30,7 @@ Some examples (all executed from the root of the repository):
3030
```
3131

3232

33-
## Debugging plugin(s)
33+
## Debugging Plugin(s)
3434
It is often useful to attach a debugger to the Gradle and Maven plugins during a project build.
3535

3636
For the Gradle plugin, this can be accomplished by passing debugger options to the Gradle daemon via `org.gradle.jvmargs`, for example:
@@ -43,7 +43,7 @@ The Gradle daemon will suspend on start-up, wait for you to attach a debugger, a
4343

4444
For the Maven plugin, simply use the `mvnDebug` command in place of the `mvn` command.
4545

46-
## Testing local changes with an existing project
46+
## Testing Local Changes with an Existing Project
4747
A common development task is to modify a plugin and then test it with an existing project.
4848

4949
To do this, first modify the project as necessary, and then build and publish the plugins to the local Maven repository:
@@ -85,7 +85,4 @@ For Maven, simply bump the version and it should try the local repository automa
8585
+ <native.maven.plugin.version>0.10.5-SNAPSHOT</native.maven.plugin.version>
8686
```
8787

88-
Then, run your build as usual. Gradle should find the plugin in the local repository and use it for the build.
89-
90-
91-
88+
Then, run your build as usual. Gradle/Maven should find the plugin in the local repository and use it for the build.

0 commit comments

Comments
 (0)