Skip to content

Commit c18f67c

Browse files
authored
Tweak readme (#189)
1 parent 7e9b63a commit c18f67c

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,18 @@ Pomgen uses the lockfiles generated by [rules_jvm_external](https://github.com/b
3131
- pomgen >= 2.0.0 is compatible with rules_jvm_external >= 5.0
3232

3333

34-
## Setup
34+
## Setup 101
3535

36-
- Add a `java_library` rule to your Bazel Package as the [default target](https://bazel.build/concepts/labels) (the target has same name as its Bazel Package, ie the directory the BUILD file lives in)
37-
- For each Maven Artifact producing Bazel Package, a [BUILD.pom](examples/hello-world/healthyfoods/fruit-api/MVN-INF/BUILD.pom) file defines Maven specific metadata
38-
- A special [marker file](examples/hello-world/healthyfoods/MVN-INF/LIBRARY.root) groups one or more Maven Artifacts into a Library
36+
- Add a `java_library` rule that builds the jar, make it the [default target](https://bazel.build/concepts/labels) (or [configure](docs/mdfiles.md#maven_artifacttarget_name) the target name)
37+
- Add a [MVN-INF/BUILD.pom](examples/hello-world/healthyfoods/fruit-api/MVN-INF/BUILD.pom) file to define Maven specific metadata (artifactId etc)
38+
- Add a [MVN-INF/LIBRARY.root](examples/hello-world/healthyfoods/MVN-INF/LIBRARY.root) file to mark the Bazel Package as a library with a single jar artifact
3939

40-
See [this doc](docs/mdfiles.md) for more information on pomgen files.
40+
See [this doc](docs/mdfiles.md) for more information on pomgen metadata files.
4141

4242

4343
## Bazel Package References
4444

45-
The BUILD file of a Maven Artifact producing Bazel Package may obviously reference other Bazel Packages in the repository. pomgen will follow these references and generate pom.xmls for all referenced Bazel Packages.
45+
The BUILD file of a Maven Artifact producing Bazel Package may obviously reference other Bazel Packages in the repository. pomgen will follow these references and generate pom.xml files for all referenced Bazel Packages.
4646

4747

4848
## Change Detection

0 commit comments

Comments
 (0)