hnock

commit 0f7b482ee45f9b4dac15fe1dfe417c09ec9c4744
parent e97f2e83e16df38ad1c17e14ce2c8446c05af0af
Author: Jared Tobin <jared@jtobin.io>
Date:   Tue,  1 Oct 2019 21:27:02 +0400

Add larger description to cabal file.

Diffstat:
M
.gitignore
 | 
1
+
M
hnock.cabal
 | 
27
++++++++++++++++++++++++++-

2 files changed, 27 insertions(+), 1 deletion(-)
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@
 *.swo
 *.o
 *.hi
+dist
diff --git a/hnock.cabal b/hnock.cabal
@@ -1,7 +1,6 @@
 name:                hnock
 version:             0.4.0
 synopsis:            A Nock interpreter.
-description:         A Nock interpreter.
 homepage:            https://github.com/jtobin/hnock
 license:             MIT
 license-file:        LICENSE
@@ -11,6 +10,32 @@ category:            Language
 build-type:          Simple
 extra-source-files:  CHANGELOG, README.md
 cabal-version:       >=1.10
+description:
+  A Nock interpreter.
+  .
+  From the shell, simply pipe Nock expressions into the hnock executable:
+  .
+  > $ echo '*[[[4 5] [6 14 15]] [0 7]]' | hnock
+  > [14 15]
+  .
+  For playing around in GHCi, import the Nock library and use hnock to parse
+  and evaluate Nock expressions:
+  .
+  > *Nock> hnock "*[[[4 5] [6 14 15]] [0 7]]"
+  > [14 15]
+  .
+  To evaluate raw nock Nouns, i.e. to compute nock(a) for some noun a, use the
+  'nock' function:
+  .
+  > *Nock> let expression = hnock "[[[4 5] [6 14 15]] [0 7]]"
+  > *Nock> expression
+  > [[[4 5] [6 [14 15]]] [0 7]]
+  > *Nock> nock expression
+  > [14 15]
+
+source-repository head
+  type: git
+  location: https://github.com/jtobin/hnock
 
 library
   default-language:    Haskell2010