diff options
| author | Rocky Madden <git@rockymadden.com> | 2013-05-10 10:48:42 -0600 |
|---|---|---|
| committer | Rocky Madden <git@rockymadden.com> | 2013-05-10 10:48:42 -0600 |
| commit | 6c8a9f1ca60822ca2ee1839bca2cd00afea7037f (patch) | |
| tree | d75b66821d6fd1a54d18c9924d739cf37af27a92 /readme.md | |
| parent | 7306d99b0a5bfef465a2ddcd977f1dd4990b5c06 (diff) | |
| download | stringmetric-6c8a9f1ca60822ca2ee1839bca2cd00afea7037f.tar.gz stringmetric-6c8a9f1ca60822ca2ee1839bca2cd00afea7037f.tar.bz2 stringmetric-6c8a9f1ca60822ca2ee1839bca2cd00afea7037f.zip | |
Lowercased all shell commands.
Diffstat (limited to 'readme.md')
| -rwxr-xr-x | readme.md | 16 |
1 files changed, 8 insertions, 8 deletions
@@ -415,7 +415,7 @@ Running the ```tar``` task will create a compressed archive __and__ an unarchive To run a command from the current directory that you would be in from doing the above: ```shell -./cli/build/stringmetric-cli/jaroMetric abc xyz +./cli/build/stringmetric-cli/jarometric abc xyz ``` Lastly, you may need to chmod the files because of the inability for Gradle to do so reliably. @@ -425,11 +425,11 @@ Every metric and algorithm has a command line interface. Said code is housed in The help option prints command syntax and usage: ```shell -$ metaphoneMetric --help +$ metaphonemetric --help Compares two strings to determine if they are phonetically similarly, per the Metaphone algorithm. Syntax: - metaphoneMetric [Options] string1 string2... + metaphonemetric [Options] string1 string2... Options: -h, --help @@ -437,11 +437,11 @@ Options: ``` ```shell -$ jaroWinklerMetric --help +$ jarowinklermetric --help Compares two strings to calculate the Jaro-Winkler distance. Syntax: - jaroWinklerMetric [Options] string1 string2... + jarowinklermetric [Options] string1 string2... Options: -h, --help @@ -452,12 +452,12 @@ Options: Compare "dog" to "dawg": ```shell -$ metaphoneMetric dog dawg +$ metaphonemetric dog dawg true ``` ```shell -$ jaroWinklerMetric dog dawg +$ jarowinklermetric dog dawg 0.75 ``` @@ -465,7 +465,7 @@ $ jaroWinklerMetric dog dawg Get the phonetic representation of "dog" using the Metaphone phonetic algorithm: ```shell -$ metaphoneAlgorithm dog +$ metaphonealgorithm dog tk ``` |