From 3a9e9220eb9f66803596e06757c83400506fbd51 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Sat, 9 Nov 2013 09:08:44 +0000 Subject: [PATCH] Set github urls in documentation as home address. --- README.md | 13 ++++++++----- project.clj | 2 +- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0454a5d..e1a5ad9 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ See http://codekata.pragprog.com/2007/01/kata_fourteen_t.html ## Installation -Download from http://example.com/FIXME. +Clone from https://github.com/simon-brooke/milkwood-clj and build with Lieningen ## Usage @@ -13,18 +13,21 @@ Download from http://example.com/FIXME. ## Options -FIXME: listing of options this app accepts. + -f, --file The path name of the file to analyse (string) + -l, --output-length 100 The length in tokens of the output to generate (integer) + -h, --no-help, --help false Print this text and exit + -o, --output The path name of the file to write to, if any (string) + -t, --tuple-length 2 The length of the sequences to analyse it into (integer) ## Examples -... +simon@engraver:~/workspace/milkwood-clj$ java -Xss4m -jar target/milkwood-clj-0.1.0-SNAPSHOT-standalone.jar -f ../milkwood/undermilkwood.txt -t 4 -l 100 + ears, conjures MRS ORGAN MORGAN And then Palestrina, SECOND VOICE he shouts to his deaf dog who smiles and licks his hands. UTAH WATKINS Gallop, you bleeding cripple! FIRST VOICE From where you are you can hear in Cockle Row in the spring, moonless night, Miss Price, in my pretty print housecoat, deft at the clothesline, natty as a jenny-wren, then pit-pat back to my egg in its cosy, my crisp toast-fingers, my home-made plum and butterpat. ### Bugs Not so much a bug, but as I've written this all as pure recursive functions it's vulnerable to stack exhaustion exceptions. I've specified extended stack size in the project file, but that won't be sufficient for analysing large texts. - - ## License Copyright © 2013 Simon Brooke diff --git a/project.clj b/project.clj index ab96e46..1896911 100644 --- a/project.clj +++ b/project.clj @@ -1,6 +1,6 @@ (defproject milkwood-clj "0.1.0" :description "Rule driven nonsense generator in Clojure" - :url "http://example.com/FIXME" + :url "https://github.com/simon-brooke/milkwood-clj" :license {:name "Eclipse Public License" :url "http://www.eclipse.org/legal/epl-v10.html"} :dependencies [[org.clojure/clojure "1.5.1"]