From 7a16bab4d2bf92f8562722df43f39dd3c36cfbe0 Mon Sep 17 00:00:00 2001 From: Simon Toens Date: Mon, 13 Jan 2025 21:23:45 +0900 Subject: [PATCH] Tweak readme --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5df47db..b90cc3a 100644 --- a/README.md +++ b/README.md @@ -31,18 +31,18 @@ Pomgen uses the lockfiles generated by [rules_jvm_external](https://github.com/b - pomgen >= 2.0.0 is compatible with rules_jvm_external >= 5.0 -## Setup +## Setup 101 - - 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) - - 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 - - A special [marker file](examples/hello-world/healthyfoods/MVN-INF/LIBRARY.root) groups one or more Maven Artifacts into a Library + - 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) + - Add a [MVN-INF/BUILD.pom](examples/hello-world/healthyfoods/fruit-api/MVN-INF/BUILD.pom) file to define Maven specific metadata (artifactId etc) + - 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 -See [this doc](docs/mdfiles.md) for more information on pomgen files. +See [this doc](docs/mdfiles.md) for more information on pomgen metadata files. ## Bazel Package References -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. +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. ## Change Detection