Skip to content

Commit

Permalink
Add documentation for installing java artifact through Maven
Browse files Browse the repository at this point in the history
  • Loading branch information
JesseMckinzie committed Jun 10, 2024
1 parent 17322fb commit 038c973
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,20 @@ target_link_libraries(client_executable PRIVATE filepattern::filepattern)

### __Java API__

```filepattern``` also supplies a Java API. Maven can be used to build ```filepattern```. After installing Maven, the following steps can be used.
```filepattern``` also supplies a Java API. To add ```filepattern``` as a dependency to a project,
the following can be added to the pom.xml of the maven project.

```xml
<dependencies>
<dependency>
<groupId>ai.polus.utils</groupId>
<artifactId>filepattern</artifactId>
<version>LATEST</version>
</dependency>
</dependencies>
```

The Java API can also be built from source using Maven. To build the project, run

```bash
git clone https://github.com/PolusAI/filepattern.git
Expand Down
27 changes: 27 additions & 0 deletions docs/source/Java.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,33 @@ To build the filepattern package from source, clone the Github repo for filepatt
from the root directory of filepattern to build the package. Alternatively, the jar can be downloaded from the Github repo
and used directly.

~~~~~~~~~~~~~~~~
Java API Install
~~~~~~~~~~~~~~~~

To add ``filepattern`` as a dependency to a project, the following can be added to the pom.xml of the maven project.

.. code-block:: xml
<dependencies>
<dependency>
<groupId>ai.polus.utils</groupId>
<artifactId>filepattern</artifactId>
<version>LATEST</version>
</dependency>
</dependencies>
The Java API can also be built from source using Maven. To build the project, run

.. code-block:: bash
git clone https://github.com/PolusAI/filepattern.git
cd filepattern
mvn clean install
To build a jar instead of installing filepattern, ``mvn clean package`` can be used in place of ``mvn clean install``.

~~~~~~~~~~~~~~~~~~~~~~
Using the Java package
Expand Down

0 comments on commit 038c973

Please sign in to comment.