From 974f568675196f870486caab2e2835e325f470b2 Mon Sep 17 00:00:00 2001
From: Jonas Schaub <44881147+JonasSchaub@users.noreply.github.com>
Date: Wed, 5 Jul 2023 22:37:40 +0200
Subject: [PATCH 1/2] Added comments for next release
---
build.gradle | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/build.gradle b/build.gradle
index 5dab7ec..31e91cc 100644
--- a/build.gradle
+++ b/build.gradle
@@ -30,7 +30,7 @@ plugins {
group = 'io.github.jonasschaub'
archivesBaseName = 'ART2a-Clustering-for-Java'
-//see also version for publishing below!
+//see also version for publishing below! And do not forget to update CITATION.cff version as well!!!
version = '1.0.2.1'
//sourceCompatibility = 1.17
@@ -98,7 +98,7 @@ publishing {
groupId = 'io.github.jonasschaub'
artifactId = 'ART2a-Clustering-for-Java'
- //note: this version has been published, do not try to publish it again! versions 1.0.1.0 and 1.0.1.1 were also already used for publishing!
+ //note: this version has been published, do not try to publish it again! versions 1.0.1.0, 1.0.1.1, and 1.0.2.0 were also already used for publishing!
version = '1.0.2.1'
from components.java
From 280c62053e1dafeee3ae3c70397cf921683db5de Mon Sep 17 00:00:00 2001
From: Jonas Schaub <44881147+JonasSchaub@users.noreply.github.com>
Date: Thu, 6 Jul 2023 15:02:39 +0200
Subject: [PATCH 2/2] Updated readme, mainly installation guide to mention the
maven artifact;
---
README.md | 49 +++++++++++++++++++++++++++++++------------------
1 file changed, 31 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
index 7a88b63..0196f21 100644
--- a/README.md
+++ b/README.md
@@ -11,41 +11,54 @@ Implementation of the ART 2-A fingerprint clustering algorithm in Java.
## Description
Implementation of the ART 2-A count and bit fingerprint clustering algorithm
in Java for fast, stable unsupervised clustering for open categorical problems
-in double or single machine precision. ART stands for adaptive resonance theory and
+in double or single machine precision. ART stands for "Adaptive Resonance Theory" and
represents a family of neural models. ART 2-A is a special form of ART that enables
rapid convergence in clustering. ART is able to adapt to changing environments.
For clustering, this means that after each assignment of an input to a cluster,
the model adapts the cluster to the new input.
+## Example initialization and usage of ART2a-Clustering-for-Java
+See the wiki of this repository.
+
+## JavaDoc
+The JavaDoc of this library can be found here.
+
+## Installation
+ART2a-Clustering-for-Java is hosted as a package/artifact on the sonatype maven central repository. See the
+artifact page for installation
+guidelines using build tools like maven or gradle.
+
+To install ART2a-Clustering-for-Java via its JAR archive, you can get it from the
+releases. Note that other dependencies
+will need to be installed via JAR archives as well this way.
+
+In order to open the project locally, e.g. to extend it, download or clone the repository and
+open it in a Gradle-supporting IDE (e.g. IntelliJ) as a Gradle project and execute the build.gradle file.
+Gradle will then take care of installing all dependencies. A Java Development Kit (JDK) of version 17 or higher must also
+be pre-installed.
+
## Contents of this repository
### Sources
The "src" subfolder contains
-all source code packages including JUnit tests.
+all source code files including JUnit tests.
### Tests
-The test class Art2aDoubleClusteringTaskTest tests the functionalities of Art-2a in double machine precision
-and the test class Art2aFloatClusteringTaskTest in single machine precision.
+The test class
+
+Art2aDoubleClusteringTest tests the functionalities of Art-2a in double machine precision
+and the test class
+
+Art2aFloatClusteringTest in single machine precision.
Methods for the clustering results are also tested.
### Test resources
-The test "resources" subfolder
+The test
+"resources" subfolder
contains two text files. The text file named "Bit_Fingerprints.txt" contains 10 bit fingerprints, where each line represents
one bit fingerprint. And the file named "Count_Fingerprints.txt" contains 6 count fingerprints, where each line represents
one count fingerprint.
-## Example initialization and usage of ART2a-Clustering-for-Java
-See the wiki of this repository.
-
-## JavaDoc
-The JavaDoc of this library can be found here.
-
-## Installation
-This is a Gradle project. In order to use the source code for your own software, download or clone the repository and
-open it in a Gradle-supporting IDE (e.g. IntelliJ) as a Gradle project and execute the build.gradle file.
-Gradle will then take care of installing all dependencies. A Java Development Kit (JDK) of version 17 or higher must also
-be pre-installed.
-
-## Dependencies
+## Dependencies for local installation
**Needs to be pre-installed:**
* Java Development Kit (JDK) version 17
* [Adoptium OpenJDK](https://adoptium.net) (as one possible source of the JDK)