Skip to content

Commit 8c2f6ed

Browse files
author
nipa
committed
Document branches
1 parent c3b367e commit 8c2f6ed

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ServiceMonitor
22

3-
An example application for [_Java 9 Module System](https://git.manning.com/agileauthor/parlog).
3+
An example application for my book [_The Java 9 Module System_](https://www.manning.com/books/the-java-9-module-system?a_aid=nipa&a_bid=869915cb).
44
The _Service Monitor_ is an application that observes a hypothetical network of microservices by
55

66
* contacting individual services
@@ -15,7 +15,16 @@ Each module has its own directory that contains the known folder structure, e.g.
1515
## Branches
1616

1717
The master branch uses basic features, except where it has to use automatic and unnamed modules for the non-modularized dependencies (Spark, Hibernate).
18-
Other branches explore individual features of the module system.
18+
Other branches explore individual features of the module system:
19+
20+
* [implied readability](../../tree/feature-implied-readability) aka `requires transitive`
21+
* [optional dependencies](../../tree/feature-optional-dependencies) aka `requires static`
22+
* [qualified exports](../../tree/feature-qualified-exports) aka `exports to`
23+
24+
Then there are some branches that explore how things can break:
25+
26+
* [duplicate modules](../../tree/break-duplicate-modules-even-if-unrequired) (not properly documented)
27+
* split package, on [compilation](../../tree/break-split-package-compilation) and [launch](../../tree/break-split-package-launch) (not properly documented)
1928

2029

2130
## Setup
@@ -29,3 +38,6 @@ The root directory contains a number of shell scripts:
2938
* `multi-compile.sh`: compiles all modules at once
3039
* `dry-run`: launches the application with `--dry-run`, which aborts before calling the main method
3140
* `run`: launches the application
41+
42+
To reduce setup efforts for IntelliJ users, I decided to leave my `.idea` folder in here.
43+
Let's see whether it helps...

0 commit comments

Comments
 (0)