readme-lhs-0.8.1: readme-lhs.cabal

cabal-version:  2.4
name:           readme-lhs
version:        0.8.1
synopsis:       Literate programming support.
description:    This package provides support for literate programming in haskell, including:
    .
    -   conversion between *.lhs and *.hs formats.
    .
    -   insertion of program output into *.lhs and *.md for fast feedback in
    development.
    .
    -   a simple wrapper for pandoc functionality.
    .
    -   a stack template, `readme-lhs`
    .
    == Usage
    .
    The best way to understand package functionality is to run the example.hs, with:
    .
    > stack build --test --exec "$(stack path --local-install-root)/bin/readme-lhs-example --file-watch
    .
    > import Readme.Lhs
    > main =
    >   void $
    >   runOutput ("other/readme_.md", GitHubMarkdown) ("readme.md", GitHubMarkdown) $
    >   output "example" (Fence "Simple example of an output")
    .
    == Template
    .
    To use the provided template, copy readme-lhs.hsfiles to a local directory, and try:
    .
    > stack new xyzzy readme-lhs

category:       Development
homepage:       https://github.com/tonyday567/readme-lhs#readme
bug-reports:    https://github.com/tonyday567/readme-lhs/issues
author:         Tony Day
maintainer:     tonyday567@gmail.com
copyright:      2016 Tony Day
license:        BSD-3-Clause
license-file:   LICENSE
build-type:     Simple
extra-source-files:
  readme.md
  other/readme-lhs.hsfiles

source-repository head
  type: git
  location: https://github.com/tonyday567/readme-lhs

library
  hs-source-dirs:
    src
  default-extensions:
  ghc-options:
    -Wall
    -Wcompat
    -Wincomplete-record-updates
    -Wincomplete-uni-patterns
    -Wredundant-constraints
  build-depends:
    attoparsec >= 0.13 && < 0.14,
    base >=4.7 && <5,
    blaze-html >= 0.9,
    containers >= 0.6,
    foldl >= 1.4,
    generic-lens >= 1.2 && < 3.0,
    numhask >= 0.7 && < 0.8,
    pandoc >= 2.10,
    pandoc-types >= 1.21,
    text >= 1.2,
    transformers >= 0.5
  exposed-modules:
    Readme.Convert
    Readme.Lhs
  other-modules:
  default-language: Haskell2010

executable readme-lhs-example
  main-is: example.hs
  hs-source-dirs:
    other
  build-depends:
    base >=4.7 && <5,
    numhask >= 0.7 && < 0.8,
    readme-lhs
  default-language: Haskell2010
  default-extensions:
  ghc-options:
    -Wall
    -Wcompat
    -Wincomplete-record-updates
    -Wincomplete-uni-patterns
    -Wredundant-constraints

test-suite test
  type: exitcode-stdio-1.0
  main-is: test.hs
  hs-source-dirs:
      test
  default-extensions:
  build-depends:
    base >=4.7 && <5,
    doctest >= 0.16 && < 0.18,
    numhask >= 0.7 && < 0.8,
    readme-lhs,
  default-language: Haskell2010