summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorRocky Madden <git@rockymadden.com>2013-01-08 09:39:41 -0700
committerRocky Madden <git@rockymadden.com>2013-01-08 09:39:41 -0700
commitb9d4f7be18cf01c64c9313500ccbdd0863fa7e1f (patch)
treea4e97be52f0d955273eaae73ef8aac95658c1e09 /readme.md
parent0da2b7666f2263a4c591ef2688094561c44a7bdb (diff)
downloadstringmetric-b9d4f7be18cf01c64c9313500ccbdd0863fa7e1f.tar.gz
stringmetric-b9d4f7be18cf01c64c9313500ccbdd0863fa7e1f.tar.bz2
stringmetric-b9d4f7be18cf01c64c9313500ccbdd0863fa7e1f.zip
Added testing sections, changed building order, and added heading to concepts.
Diffstat (limited to 'readme.md')
-rwxr-xr-xreadme.md32
1 files changed, 22 insertions, 10 deletions
diff --git a/readme.md b/readme.md
index 9bd59e9..3e3f9d0 100755
--- a/readme.md
+++ b/readme.md
@@ -1,6 +1,8 @@
#stringmetric [![Build Status](https://secure.travis-ci.org/rockymadden/stringmetric.png)](http://travis-ci.org/rockymadden/stringmetric)
A Scala library of string metrics and phonetic algorithms. Each has a command line interface, is thoroughly unit tested, and performant (verified via microbenchmark suites).
+__Concepts:__
+
* __Similarity metrics__ determine the distance or coefficient between two arguments.
* __Phonetic metrics__ determine if two arguments sound the same phonetically.
* __Phonetic algorithms__ determine the phonetic representation of the argument passed. All phonetic metrics have a standalone algorithm counterpart.
@@ -76,17 +78,15 @@ Get the phonetic representation of "abc" using the Metaphone phonetic algorithm:
$ metaphoneAlgorithm abc
```
-## Depending on the API
-Available on the [Maven Central Repository](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.rockymadden.stringmetric%22):
-
-* __groupId__: com.rockymadden.stringmetric
-* __artifactId__: stringmetric-core
-
-## Depending on the CLI
-Available on the [Maven Central Repository](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.rockymadden.stringmetric%22):
+## Testing the API
+```shell
+$ gradle :stringmetric-core:test
+```
-* __groupId__: com.rockymadden.stringmetric
-* __artifactId__: stringmetric-cli
+## Testing the CLI
+```shell
+$ gradle :stringmetric-cli:test
+```
## Building the API
```shell
@@ -98,6 +98,18 @@ $ gradle :stringmetric-core:jar
$ gradle :stringmetric-cli:tar
```
+## Depending on the API
+Available on the [Maven Central Repository](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.rockymadden.stringmetric%22):
+
+* __groupId__: com.rockymadden.stringmetric
+* __artifactId__: stringmetric-core
+
+## Depending on the CLI
+Available on the [Maven Central Repository](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.rockymadden.stringmetric%22):
+
+* __groupId__: com.rockymadden.stringmetric
+* __artifactId__: stringmetric-cli
+
## Requirements
* Scala 2.9.x
* Gradle 1.x