documentation overhaul continued

[github/fretlink/text-pipes.git] / pipes-text.cabal

diff --git a/pipes-text.cabal b/pipes-text.cabal
index 9af2a09c4dd12f248056e4a3e2c7af921c2289c0..f38b7f2e5662082fd3c2d7879acec7587d5cc6c5 100644 (file)
--- a/pipes-text.cabal
+++ b/pipes-text.cabal
@@ -1,52 +1,55 @@
 name:                pipes-text
-version:             0.0.0.0
+version:             0.0.0.7
 synopsis:            Text pipes.
-description:         Many of the pipes and other operations defined here mirror those in
-                     the `pipes-bytestring` library. Folds like `length` and grouping 
-                     operations like `lines` simply  adjust for the differences between 
-                     `ByteString` and `Text` and `Word8` and `Char`. The distinctive feature
-                     of the library is the `Text/ByteString` encoding and decoding apparatus.
+description:         * This package will be in a draft, or testing, phase until version 0.0.1. Please report any installation difficulties, or any wisdom about the api, on the github page!
                      .
-                     To this core are added some simple functions akin to the `String` 
-                     operations in `Pipes.Prelude`, and others like the utilities in `Data.Text`.  
+                     This organization of the package follows the rule 
                      .
-                     All of the `IO` operations defined here - e.g `readFile`, `stdout` etc. 
-                     - are conveniences akin to those in `Data.Text.IO` which e.g. try to 
-                     find the system encoding and use the exceptions defined in the `text`
-                     library. Proper `IO` in the sense of this library will employ 
-                     `pipes-bytestring` in conjuntion with 'pure' operations like 
-                     `decodeUtf8` and `encodeUtf8` that are defined here. 
+                     * @pipes-text : pipes-bytestring :: text : bytestring@ 
+                     .
+                     Familiarity with the other three packages should give one an idea what to expect where. The package has three modules, @Pipes.Text@ , @Pipes.Text.Encoding@ and @Pipes.Text.IO@; the division has more or less the significance it has in the @text@ library. 
+                     .
+                     Note that the module @Pipes.Text.IO@ is present as a convenience (as is @Data.Text.IO@).  Official pipes IO would use @Pipes.ByteString@ and the decoding functions present here, based on the new Michael Snoyman's new @text-stream-decoding@ package.  In particular, the @Pipes.Text.IO@ functions use Text exceptions. 
+                     .
+                     @Pipes.Text.IO@ uses version 0.11.3 or later of the @text@ library. It thus works with the version of @text@ that came with the 2013 Haskell Platform. To use an older @text@, install with the flag @-fnoio@
 
 homepage:            https://github.com/michaelt/text-pipes
 bug-reports:         https://github.com/michaelt/text-pipes/issues
-
 license:             BSD3
 license-file:        LICENSE
 author:              Michael Thompson
 maintainer:          what_is_it_to_do_anything@yahoo.com
 category:            Text, Pipes
-
 build-type:          Simple
 cabal-version:       >=1.10
-extra-source-files: README.md
-                    include/*.h 
+
+extra-source-files: README.md changelog
+source-repository head
+    type: git
+    location: https://github.com/michaelt/text-pipes
+
+flag noio
+  default: False
+  Description: Use a version of text earlier than 0.11.3
 
 library
-  c-sources:    cbits/cbits.c
-  include-dirs: include
-  exposed-modules:     Pipes.Text, Pipes.Text.Internal
-  other-modules:       Pipes.Text.Internal.Decoding, Pipes.Text.Internal.Codec
-  other-extensions:    RankNTypes
-  build-depends:       base         >= 4       && < 5  ,
-                       bytestring >=0.10       && < 0.11,
-                       text >=0.11             && < 1.2,
-                       profunctors  >= 3.1.1   && < 4.1 ,
-                       pipes >=4.0             && < 4.2,
-                       pipes-group  >= 1.0.0   && < 1.1 ,
-                       pipes-parse >=2.0       && < 3.1,
+  exposed-modules:     Pipes.Text, Pipes.Text.Encoding
+  build-depends:       base >= 4                  && < 5  ,
+                       bytestring >= 0.9                  ,
+                       text >=0.11.2              && < 1.2,
+                       text-stream-decode >= 0.1  && < 0.2,  
+                       profunctors  >= 3.1.1      && < 4.1,
+                       pipes >=4.0                && < 4.2,
+                       pipes-group  >= 1.0.0      && < 1.1,
+                       pipes-parse >=2.0          && < 3.1,
                        pipes-safe, 
-                       pipes-bytestring >= 1.0 && < 2.1,
-                       transformers >= 0.2.0.0 && < 0.4
-  -- hs-source-dirs:      
+                       pipes-bytestring >= 1.0    && < 2.1,
+                       transformers >= 0.2.0.0    && < 0.4
+  other-extensions:    RankNTypes
   default-language:    Haskell2010
-  ghc-options: -O2 
+  ghc-options: -O2
+
+  if !flag(noio)
+    exposed-modules:   Pipes.Text.IO
+    build-depends:     text >=0.11.3              && < 1.2
+