sampling

commit 758f91929c590b14a334f5e3e132205b441d26df
parent 61f1ccabe76270583dc679c1cb9adbf21ee156bb
Author: Jared Tobin <jared@jtobin.ca>
Date:   Mon,  8 Feb 2016 19:16:57 +1300

Update readme, cabal file.

Diffstat:
M
README.md
 | 
10
+++++++++-
M
sampling.cabal
 | 
16
++++++++++++----

2 files changed, 21 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
@@ -1,3 +1,11 @@
 # sampling
 
-Basic tools for sampling from collections.
+Basic sampling tools.
+
+Exports variations on two simple functions for sampling from arbitrary
+'Foldable' collections:
+
+* 'sample', for sampling without replacement
+* 'resample', for sampling with replacement (i.e. a bootstrap)
+
+
diff --git a/sampling.cabal b/sampling.cabal
@@ -10,9 +10,14 @@ category:            Math
 build-type:          Simple
 cabal-version:       >=1.10
 description:
-  Basic tools for sampling from arbitrary collections.
+  Basic sampling tools.
   .
-  FIXME make me more informative.
+  Exports variations on two simple functions for sampling from arbitrary
+  'Foldable' collections:
+  .
+  * 'sample', for sampling without replacement
+  .
+  * 'resample', for sampling with replacement (i.e., a bootstrap)
 
 Source-repository head
   Type:     git
@@ -21,7 +26,8 @@ Source-repository head
 library
   default-language:    Haskell2010
   hs-source-dirs:      lib
-  ghc-options:         -O2
+  ghc-options:
+    -Wall -O2
   other-modules:
     Numeric.Sampling.Internal
   exposed-modules:
@@ -38,7 +44,9 @@ executable sample-test
   hs-source-dirs:    src
   Main-is:           Main.hs
   default-language:  Haskell2010
-  ghc-options: -O2
+  ghc-options:
+    -Wall -O2
   build-depends:
       base
     , sampling
+