From 64cc886bb5faa559c76e373f645e2c263a40962b Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Thu, 13 Aug 2015 11:52:10 -0700 Subject: [PATCH] ui: update cabal file, readme, changelog --- hledger-ui/CHANGES | 7 +++ hledger-ui/README | 10 ++-- hledger-ui/hledger-ui.cabal | 96 +++++++++++++++++++--------------- hledger-ui/package.yaml | 101 ++++++++++++++++++++++++++++++++++++ 4 files changed, 168 insertions(+), 46 deletions(-) create mode 100644 hledger-ui/CHANGES create mode 100644 hledger-ui/package.yaml diff --git a/hledger-ui/CHANGES b/hledger-ui/CHANGES new file mode 100644 index 000000000..e91090246 --- /dev/null +++ b/hledger-ui/CHANGES @@ -0,0 +1,7 @@ +User-visible changes in hledger-ui. + +0.27 (unreleased) + +- hledger-ui is the new name for hledger-vty, the curses-style text + UI. It is intended to be installed by all hledger users, except on + (native) Windows where vty is not supported. diff --git a/hledger-ui/README b/hledger-ui/README index 6fd55d311..d5e78be19 100644 --- a/hledger-ui/README +++ b/hledger-ui/README @@ -1,4 +1,8 @@ -A curses-style console interface for the hledger accounting tool. -hledger-vty was revived in 2015 to become this package. -It allows browsing the balance, register and print reports with cursor keys and scrolling. +A curses-style text user interface for the hledger accounting tool. +hledger-ui is the new name for hledger-vty. Revived in 2015, this +package is intended to be installed as standard by all hledger users, +except those on (native) Windows, where it is not supported. + +hledger-ui currently allows browsing the balance, register and print +reports, with drill-down and scrolling. diff --git a/hledger-ui/hledger-ui.cabal b/hledger-ui/hledger-ui.cabal index 97d13b13c..15c095e9e 100644 --- a/hledger-ui/hledger-ui.cabal +++ b/hledger-ui/hledger-ui.cabal @@ -1,61 +1,71 @@ +-- This file has been generated from package.yaml by hpack version 0.5.4. +-- +-- see: https://github.com/sol/hpack + name: hledger-ui -version: 0.26.98 -category: Finance -synopsis: A curses-style console interface for the hledger accounting tool. -description: - hledger is a library and set of user tools for working +version: 0.26.98 +category: Finance, Console +synopsis: A curses-style text user interface for the hledger accounting tool. +description: hledger is a library and set of user tools for working with financial data (or anything that can be tracked in a double-entry accounting ledger.) It is a haskell port and friendly fork of John Wiegley's Ledger. hledger provides command-line, curses and web interfaces, and aims to be a reliable, practical tool for daily use. - license: GPL license-file: LICENSE author: Simon Michael maintainer: Simon Michael homepage: http://hledger.org -bug-reports: http://code.google.com/p/hledger/issues +bug-reports: http://bugs.hledger.org stability: beta -tested-with: GHC==7.10 -cabal-version: >= 1.6 +cabal-version: >= 1.10 build-type: Simple --- data-dir: data --- data-files: -extra-tmp-files: -extra-source-files: - CHANGES - README + +extra-source-files: + CHANGES + README source-repository head - type: darcs - location: http://joyful.com/repos/hledger + type: git + location: https://github.com/simonmichael/hledger + +flag threaded + default: True + description: + Build with support for multithreaded execution + +flag old-locale + default: False + description: + A compatibility flag, set automatically by cabal. + If false then depend on time >= 1.5, + if true then depend on time < 1.5 together with old-locale. executable hledger-ui - main-is: hledger-ui.hs - ghc-options: -threaded -W - other-modules: - Hledger.UI - Hledger.UI.Main - Hledger.UI.Options + main-is: hledger-ui.hs + hs-source-dirs: + . + ghc-options: -Wall -fno-warn-unused-do-bind -fno-warn-name-shadowing -fno-warn-missing-signatures -fno-warn-type-defaults -fno-warn-orphans + if flag(threaded) + ghc-options: -threaded + cpp-options: -DVERSION="0.26.98" build-depends: - hledger == 0.26.98 - ,hledger-lib == 0.26.98 - ,HUnit - ,base >= 3 && < 5 - ,cmdargs >= 0.8 - -- ,containers - -- ,csv - -- ,directory - -- ,filepath - -- ,mtl - -- ,old-locale - -- ,old-time - -- ,parsec - -- ,process - -- ,regexpr >= 0.5.1 - ,safe >= 0.2 - -- ,split == 0.1.* - ,time - -- ,utf8-string >= 0.3.5 && < 0.4 - ,vty >= 5.2 && < 5.4 + hledger == 0.26.98 + , hledger-lib == 0.26.98 + , base >= 3 && < 5 + , cmdargs >= 0.8 + , HUnit + , safe >= 0.2 + , vty >= 5.2 && < 5.4 + if impl(ghc >= 7.4) + build-depends: pretty-show >= 1.6.4 + if flag(old-locale) + build-depends: time < 1.5, old-locale + else + build-depends: time >= 1.5 + other-modules: + Hledger.UI + Hledger.UI.Main + Hledger.UI.Options + default-language: Haskell2010 diff --git a/hledger-ui/package.yaml b/hledger-ui/package.yaml new file mode 100644 index 000000000..61923dd39 --- /dev/null +++ b/hledger-ui/package.yaml @@ -0,0 +1,101 @@ +# hpack specification for generating the cabal file +# https://github.com/sol/hpack#readme +# http://www.haskell.org/cabal/release/cabal-latest/doc/users-guide/authors.html +# +# as of hpack 0.5.4 these must be added manually: +# - tested-with +# - flags +# - benchmarks +# - conditional blocks + +name : hledger-ui +version : '0.26.98' +stability : beta +category : Finance, Console +synopsis : A curses-style text user interface for the hledger accounting tool. +description : | + hledger is a library and set of user tools for working + with financial data (or anything that can be tracked in a + double-entry accounting ledger.) It is a haskell port and + friendly fork of John Wiegley's Ledger. hledger provides + command-line, curses and web interfaces, and aims to be a + reliable, practical tool for daily use. + +license : GPL +author : Simon Michael +maintainer : Simon Michael +github : simonmichael/hledger +homepage : http://hledger.org +bug-reports : http://bugs.hledger.org +# XXX not supported +tested-with : GHC==7.10.2 + +extra-source-files: + - CHANGES + - README + +# XXX not supported +# flag: +# old-locale: +# - default: False +# - description: +# A compatibility flag, set automatically by cabal. +# If false then depend on time >= 1.5, +# if true then depend on time < 1.5 together with old-locale. + +ghc-options: + -Wall + -fno-warn-unused-do-bind + -fno-warn-name-shadowing + -fno-warn-missing-signatures + -fno-warn-type-defaults + -fno-warn-orphans + +cpp-options: -DVERSION="0.26.98" + +executables: + hledger-ui: + source-dirs: . + main: hledger-ui.hs + # if flag(threaded) + # ghc-options: -threaded + ghc-options: + -threaded + dependencies: + - hledger == 0.26.98 + - hledger-lib == 0.26.98 + - base >= 3 && < 5 + - cmdargs >= 0.8 + - HUnit + - safe >= 0.2 + - vty >= 5.2 && < 5.4 + # XXX not supported + # if impl(ghc >= 7.4) + # build-depends: pretty-show >= 1.6.4 + - pretty-show >= 1.6.4 + # if flag(old-locale) + # build-depends: time < 1.5, old-locale + # else + # build-depends: time >= 1.5 + - time >= 1.5 + +# tests: +# test: +# source-dirs: test +# main: test.hs +# dependencies: +# - hledger-ui +# - test-framework +# - test-framework-hunit + +# XXX not supported +# benchmarks: +# bench: +# source-dirs: bench +# main: bench.hs +# other-modules: SimpleBench +# dependencies: +# - hledger-ui +# - criterion +# - html +# - timeit