Skip to content

Commit b085de7

Browse files
committed
Add notes about working with jgitver in IntelliJ
1 parent be6b36d commit b085de7

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,24 @@ To build a mock server, callers should use a [`MockApnsServerBuilder`](https://p
241241

242242
Callers may also provide a [`MockApnsServerListener`](https://pushy-apns.org/apidocs/0.15/com/eatthepath/pushy/apns/server/MockApnsServerListener.html) when building a mock server; listeners are notified whenever the mock server accepts or rejects a notification from a client.
243243

244+
## Building Pushy
245+
246+
Pushy uses [Maven](https://maven.apache.org/) as its build system. To build Pushy from source:
247+
248+
```shell
249+
./mvnw clean package
250+
```
251+
252+
…or to run tests:
253+
254+
```shell
255+
./mvnw clean test
256+
```
257+
258+
### For IntelliJ IDEA users
259+
260+
Note that IntelliJ IDEA struggles with multi-module projects that set their versions on the fly (like Pushy). Please see [IDEA-187928](https://youtrack.jetbrains.com/issue/IDEA-187928/Jgitver-not-working-at-all-for-a-multimodule-project) for background and discussion. To work around the issue, though, IntelliJ users can navigate to Settings → Build, Execution, Deployment → Build Tools → Maven → Importing and add `-Djgitver.skip=true` to "VM options for importer."
261+
244262
## License and status
245263

246264
Pushy is available under the [MIT License](https://github.com/jchambers/pushy/blob/master/LICENSE.md).

0 commit comments

Comments
 (0)