Skip to content

Commit

Permalink
Add pom,update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Maarten committed Oct 30, 2016
1 parent 611f26f commit 3ceb910
Show file tree
Hide file tree
Showing 3 changed files with 167 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@ hs_err_pid*
gradle/
gradlew
*.gradle
gradlew.*
gradlew.*
target/
18 changes: 18 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
# Nondeterministic finite state automata
This is a library that provides an implemention [nondeterminstic finite state automata](https://en.wikipedia.org/wiki/Nondeterministic_finite_automaton) (NFAs) in Java. You can think of NFAs as flowcharts: you are in a state, take some action, and arrive in a new state. The action can produce a side effect, such as writing a string to a tape.

## Usage
Download [the latest JAR](https://github.com/digitalheir/nfa/releases/latest) or grab from Maven:

```xml
<dependencies>
<dependency>
<groupId>org.leibnizcenter</groupId>
<artifactId>nfa</artifactId>
<version>1.0.0</version>
</dependency>
</dependencies>
```

or Gradle:
```groovy
compile 'org.leibnizcenter:nfa:0.9.6'
```

## Why?
There are already a bunch of libraries out there which work with deterministic finite state automata (DFAs), and there is a well-known result in automata theory which says that for any language recognized by an NFA, we can construct a DFA which recognizes the same language.

Expand Down
147 changes: 147 additions & 0 deletions pom.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>org.leibnizcenter</groupId>
<artifactId>nfa</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>

<licenses>
<license>
<name>MIT License</name>
<url>http://www.opensource.org/licenses/mit-license.php</url>
</license>
</licenses>

<developers>
<developer>
<name>Maarten Trompper</name>
<email>[email protected]</email>
<organization>Leibniz Center for Law</organization>
<organizationUrl>http://www.leibnizcenter.org/</organizationUrl>
</developer>
</developers>

<name>${project.groupId}:${project.artifactId}</name>
<description>Streaming non-deterministic finite automata</description>
<url>https://github.com/digitalheir/java-nfa</url>

<scm>
<connection>scm:git:[email protected]:digitalheir/java-nfa</connection>
<developerConnection>scm:git:[email protected]:digitalheir/java-nfa.git</developerConnection>
<url>[email protected]:digitalheir/java-nfa.git</url>
</scm>

<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>20.0</version>
</dependency>

<dependency>
<groupId>com.github.krukow</groupId>
<artifactId>clj-ds</artifactId>
<version>0.0.4</version>
</dependency>
<dependency>
<groupId>org.jetbrains</groupId>
<artifactId>annotations</artifactId>
<version>RELEASE</version>
</dependency>
</dependencies>
<distributionManagement>
<snapshotRepository>
<id>ossrh</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</snapshotRepository>
<repository>
<id>ossrh</id>
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
</repository>
</distributionManagement>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
<version>3.3</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>2.4</version>
<configuration>
<!--<encoding>UTF-8</encoding>-->
</configuration>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
<configuration>
<additionalparam>-Xdoclint:none</additionalparam>
</configuration>
</plugin>
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>1.6.7</version>
<extensions>true</extensions>
<configuration>
<serverId>ossrh</serverId>
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
<autoReleaseAfterClose>true</autoReleaseAfterClose>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>1.6</version>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
</properties>
</project>

0 comments on commit 3ceb910

Please sign in to comment.