Weaken Cabal bounds, remove example test-suite

The lower bound on Cabal was unnecessary and has been relaxed. The
example test-suite, which includes failures, has been removed so that
the project does not appear to be failing its tests. The Example module
is still available, now with some extra documentation, and the readme
has been updated to include the relevant information that should be in a
Cabal file.  The source has also been tidied by stylish-haskell.

README.md

@@ -0,0 +1,9 @@
+cabal-test-quickcheck
+=====================
+
+Support for QuickCheck with the 'detailed' Cabal testing interface. See
+`test/Example.hs` for an example of use.
+
+Set the `type` of your test-suite to `detailed-0.9`, and point the `test-module`
+field to the module which exports your `tests`. Configure with the
+`--enable-tests` option and run `cabal test`.

cabal-test-quickcheck.cabal

@@ -1,5 +1,5 @@
 name:          cabal-test-quickcheck
-version:       0.1.3
+version:       0.1.4
 license:       MIT
 license-file:  LICENSE
 author:        Timothy Jones
@@ -28,20 +28,6 @@ library
     Cabal      >= 1.16 && < 1.23,
     QuickCheck >= 2.6  && < 2.8
 
-test-suite example
-  type:        detailed-0.9
-  test-module: Example
-
-  hs-source-dirs:   test
-  default-language: Haskell2010
-
-  ghc-options: -Wall -Werror
-
-  build-depends:
-    base  >= 4.6  && < 4.8,
-    Cabal >= 1.19 && < 1.23,
-    cabal-test-quickcheck
-
 source-repository head
   type:     git
   location: git://github.com/zmthy/cabal-test-quickcheck.git

src/Distribution/TestSuite/QuickCheck.hs

@@ -13,13 +13,12 @@ module Distribution.TestSuite.QuickCheck
     , testGroup
     ) where
 
-------------------------------------------------------------------------------
-import Control.Applicative    ((<$>), (<|>))
-import Control.Monad          (foldM)
-import Data.List              (isSuffixOf, stripPrefix)
-import Data.Maybe             (catMaybes, fromMaybe)
-import Distribution.TestSuite hiding (Result)
-import Test.QuickCheck
+import           Control.Applicative    ((<$>), (<|>))
+import           Control.Monad          (foldM)
+import           Data.List              (isSuffixOf, stripPrefix)
+import           Data.Maybe             (catMaybes, fromMaybe)
+import           Distribution.TestSuite hiding (Result)
+import           Test.QuickCheck
 
 
 ------------------------------------------------------------------------------

test/Example.hs

@@ -1,24 +1,27 @@
 ------------------------------------------------------------------------------
+-- | An example testing module for cabal-test-quickcheck. The `test-module` of
+-- a test-suite must export a 'tests' definition.
 module Example (tests) where
 
-------------------------------------------------------------------------------
-import Distribution.TestSuite.QuickCheck
+import           Distribution.TestSuite.QuickCheck
 
 
 ------------------------------------------------------------------------------
+-- | The root definition of the tests. Must be of type 'IO [Test]'.
 tests :: IO [Test]
 tests = return
     [ testProperty "Succeeds" True
     , testProperty "Fails" False
-    , testGroup "May fail" mayFail
+    , mayFail
     ]
 
 
 ------------------------------------------------------------------------------
-mayFail :: [Test]
-mayFail =
+-- | A list of tests can be grouped together into a single test.
+mayFail :: Test
+mayFail = testGroup "May fail"
     [ testProperty "Maybe fails" neqNegation
-    , testProperty "Probably fails" $ not . neqNegation
+    , testProperty "Probably fails" (not . neqNegation)
     ]
 
 neqNegation :: Int -> Bool