Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Hellblazer committed Aug 14, 2023
1 parent 011dec9 commit ad4cb18
Showing 1 changed file with 43 additions and 1 deletion.
44 changes: 43 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,46 @@ This library is licensed under the AGPL v3.0, requires Java 20+ and is built wit
mvn clean install

## Current Status
Raised from the dead. The GUI is now a crude, but servicable Java/FX GUI. Probably will work on cleaning that up and improving that, but...
Raised from the dead. The GUI is now a crude, but servicable Java/FX GUI. Probably will work on cleaning that up and improving that, but...

## Maven Artifacts
Currently, Voronoi-3D is in active development and does not publish to maven central. Rather, periodic snapshots (and releases when they happen)
will be uploaded to the [repo-hell]() repository. If you would like to use Voronoi-3D maven artifacts, you'll need to add the following repository
declarations to your pom.xml The maven coordinates for individual artifacts are found below.

<repositories>
<repository>
<id>hell-repo</id>
<url>https://raw.githubusercontent.com/Hellblazer/repo-hell/main/mvn-artifact</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>

<pluginRepositories>
<pluginRepository>
<id>plugin-hell-repo</id>
<url>https://raw.githubusercontent.com/Hellblazer/repo-hell/main/mvn-artifact</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>

### Voronoi 3D library

<dependency>
<groupId>com.hellblazer</groupId>
<artifactId>voronoi-3d</artifactId>
<version>0.1.0-SNAPSHOT</version>
</dependency>

### Voronoi 3D GUI library

<dependency>
<groupId>com.hellblazer</groupId>
<artifactId>voronoi-3d-gui</artifactId>
<version>0.1.0-SNAPSHOT</version>
</dependency>

0 comments on commit ad4cb18

Please sign in to comment.