From 4fefc43d9a7c858556a13931331057c1d68561d7 Mon Sep 17 00:00:00 2001 From: JesseMckinzie Date: Thu, 23 May 2024 08:57:45 -0600 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 540ab2f7..8b9bfb29 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,6 @@ or by running pip install -i https://pypi.org/simple/ filepattern - ## Build and Install Alternatively, ``filepattern`` can either be build inside a `conda` environment or independently outside of it directly from the source. @@ -71,6 +70,20 @@ find_package(filepattern REQUIRED) 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. + +```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```. + +For more information of the Java API, see the [Java API documentation](https://filepattern.readthedocs.io/en/latest/Java.html) +

Filepattern

When only a path to a directory and a pattern are supplied to the constructor of ``filepattern``, ``filepattern`` will iterate over the directory, matching the filenames in the directory to the ``filepattern``. The ``filepattern`` can either be supplied by the user or can be found using the ``infer_pattern`` method of ``filepattern``. For example, consider a directory containing the following files,