literatex 0.2.0.1 → 0.2.0.2
raw patch · 15 files changed
+51/−34 lines, 15 filesdep ~basedep ~filepathdep ~optparse-applicativePVP ok
version bump matches the API change (PVP)
Dependency ranges changed: base, filepath, optparse-applicative, tasty, tasty-hunit, ttc
API changes (from Hackage documentation)
Files
- CHANGELOG.md +6/−0
- LICENSE +1/−1
- README.md +26/−17
- app/LibOA.hs +2/−2
- app/Main.hs +1/−1
- literatex.cabal +4/−4
- src/LiterateX.hs +3/−1
- src/LiterateX/Parser.hs +1/−1
- src/LiterateX/Renderer.hs +1/−1
- src/LiterateX/SourceDefaults.hs +1/−1
- src/LiterateX/Types.hs +1/−1
- src/LiterateX/Types/CodeLanguage.hs +1/−1
- src/LiterateX/Types/SourceFormat.hs +1/−1
- src/LiterateX/Types/SourceLine.hs +1/−1
- src/LiterateX/Types/TargetFormat.hs +1/−1
CHANGELOG.md view
@@ -24,6 +24,12 @@ [KaC]: <https://keepachangelog.com/en/1.0.0/> +## 0.2.0.2 (2022-02-05)++### Non-Breaking++* Bump `optparse-applicative` dependency version upper bound+ ## 0.2.0.1 (2021-12-25) ### Non-Breaking
LICENSE view
@@ -1,6 +1,6 @@ The MIT License -Copyright (c) 2021 Travis Cardwell+Copyright (c) 2021-2022 Travis Cardwell Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal
README.md view
@@ -19,15 +19,16 @@ * [CLI](#cli) * [Requirements](#requirements) * [Installation](#installation)- * [Installation From Source](#installation-from-source) * [`.deb` Package Installation](#deb-package-installation) * [`.rpm` Package Installation](#rpm-package-installation)+ * [Installation From Hackage](#installation-from-hackage)+ * [Installation From Stackage](#installation-from-stackage) * [Usage](#usage) * [Library](#library) * [Related Work](#related-work) * [Project](#project) * [Links](#links)- * [Releases](#releases)+ * [Tags](#tags) * [Contribution](#contribution) * [License](#license) @@ -261,29 +262,37 @@ ### Installation -#### Installation From Source+#### `.deb` Package Installation -`literatex` can be built from source using [Stack][]. For example, you can-install the latest release (to `/usr/local` on Linux) as follows:+Check the [Releases][] page for `.deb` packages. +[Releases]: <https://github.com/ExtremaIS/literatex-haskell/releases>++#### `.rpm` Package Installation++Check the [Releases][] page for `.rpm` packages.++#### Installation From Hackage++Install `literatex` from [Hackage][] using [Cabal][] as follows:+ ```-$ git clone https://github.com/ExtremaIS/literatex-haskell.git-$ cd literatex-haskell-$ make-$ sudo make install+$ cabal v2-install literatex ``` -[Stack]: <https://www.haskellstack.org>--#### `.deb` Package Installation+[Hackage]: <https://hackage.haskell.org/package/literatex>+[Cabal]: <https://www.haskell.org/cabal/> -Check the [Releases][] page for `.deb` packages.+#### Installation From Stackage -#### `.rpm` Package Installation+Install `literatex` from [Stackage][] using [Stack][] as follows: -Check the [Releases][] page for `.rpm` packages.+```+$ stack install literatex+``` -[Releases]: <https://github.com/ExtremaIS/literatex-haskell/releases>+[Stackage]: <https://www.stackage.org/package/literatex>+[Stack]: <https://haskellstack.org/> ### Usage @@ -346,7 +355,7 @@ * GitHub: <https://github.com/ExtremaIS/literatex-haskell> -### Releases+### Tags All releases are tagged in the `main` branch. Release tags are signed using the
app/LibOA.hs view
@@ -2,7 +2,7 @@ -- | -- Module : LibOA -- Description : supplementary functions for optparse-applicative--- Copyright : Copyright (c) 2019-2021 Travis Cardwell+-- Copyright : Copyright (c) 2019-2022 Travis Cardwell -- License : MIT -- -- This is a collection of functions that I often use with@@ -11,7 +11,7 @@ -- projects as required. If the library grows to a substantial size or others -- with to use it, I will reconsider. ----- Revision: 2021-07-20+-- Revision: 2022-01-02 ------------------------------------------------------------------------------ {-# LANGUAGE CPP #-}
app/Main.hs view
@@ -2,7 +2,7 @@ -- | -- Module : Main -- Description : literatex command-line utility--- Copyright : Copyright (c) 2021 Travis Cardwell+-- Copyright : Copyright (c) 2021-2022 Travis Cardwell -- License : MIT ------------------------------------------------------------------------------
literatex.cabal view
@@ -1,5 +1,5 @@ name: literatex-version: 0.2.0.1+version: 0.2.0.2 category: Utils synopsis: transform literate source code to Markdown description:@@ -11,7 +11,7 @@ bug-reports: https://github.com/ExtremaIS/literatex-haskell/issues author: Travis Cardwell <travis.cardwell@extrema.is> maintainer: Travis Cardwell <travis.cardwell@extrema.is>-copyright: Copyright (c) 2021 Travis Cardwell+copyright: Copyright (c) 2021-2022 Travis Cardwell license: MIT license-file: LICENSE @@ -23,7 +23,7 @@ || ==8.6.5 || ==8.8.4 || ==8.10.7- || ==9.0.1+ || ==9.0.2 || ==9.2.1 extra-source-files:@@ -79,7 +79,7 @@ build-depends: ansi-wl-pprint >=0.6 && <0.7 , base- , optparse-applicative >=0.14 && <0.17+ , optparse-applicative >=0.14 && <0.18 , literatex , ttc default-language: Haskell2010
src/LiterateX.hs view
@@ -2,7 +2,7 @@ -- | -- Module : LiterateX -- Description : API--- Copyright : Copyright (c) 2021 Travis Cardwell+-- Copyright : Copyright (c) 2021-2022 Travis Cardwell -- License : MIT -- -- This module provides high-level as well as low-level API functions for@@ -87,6 +87,8 @@ -- $Constants -- | LiterateX version string (\"@literatex-haskell X.X.X@\")+--+-- @since 0.0.1.0 version :: String version = "literatex-haskell " ++ showVersion Project.version
src/LiterateX/Parser.hs view
@@ -2,7 +2,7 @@ -- | -- Module : LiterateX.Parser -- Description : source parser--- Copyright : Copyright (c) 2021 Travis Cardwell+-- Copyright : Copyright (c) 2021-2022 Travis Cardwell -- License : MIT -- -- This module implements the source parser.
src/LiterateX/Renderer.hs view
@@ -2,7 +2,7 @@ -- | -- Module : LiterateX.Renderer -- Description : target renderer--- Copyright : Copyright (c) 2021 Travis Cardwell+-- Copyright : Copyright (c) 2021-2022 Travis Cardwell -- License : MIT -- -- This module implements the target renderer.
src/LiterateX/SourceDefaults.hs view
@@ -2,7 +2,7 @@ -- | -- Module : LiterateX.SourceDefaults -- Description : default options by source extension--- Copyright : Copyright (c) 2021 Travis Cardwell+-- Copyright : Copyright (c) 2021-2022 Travis Cardwell -- License : MIT -- -- This module provides some default options for various sources.
src/LiterateX/Types.hs view
@@ -2,7 +2,7 @@ -- | -- Module : LiterateX.Types -- Description : type re-exports for convenience--- Copyright : Copyright (c) 2021 Travis Cardwell+-- Copyright : Copyright (c) 2021-2022 Travis Cardwell -- License : MIT -- -- The type modules are generally imported qualified, so the types are
src/LiterateX/Types/CodeLanguage.hs view
@@ -2,7 +2,7 @@ -- | -- Module : LiterateX.Types.CodeLanguage -- Description : source code language type--- Copyright : Copyright (c) 2021 Travis Cardwell+-- Copyright : Copyright (c) 2021-2022 Travis Cardwell -- License : MIT ------------------------------------------------------------------------------
src/LiterateX/Types/SourceFormat.hs view
@@ -2,7 +2,7 @@ -- | -- Module : LiterateX.Types.SourceFormat -- Description : source format type--- Copyright : Copyright (c) 2021 Travis Cardwell+-- Copyright : Copyright (c) 2021-2022 Travis Cardwell -- License : MIT ------------------------------------------------------------------------------
src/LiterateX/Types/SourceLine.hs view
@@ -2,7 +2,7 @@ -- | -- Module : LiterateX.Types.SourceLine -- Description : source line type--- Copyright : Copyright (c) 2021 Travis Cardwell+-- Copyright : Copyright (c) 2021-2022 Travis Cardwell -- License : MIT ------------------------------------------------------------------------------
src/LiterateX/Types/TargetFormat.hs view
@@ -2,7 +2,7 @@ -- | -- Module : LiterateX.Types.TargetFormat -- Description : target format type--- Copyright : Copyright (c) 2021 Travis Cardwell+-- Copyright : Copyright (c) 2021-2022 Travis Cardwell -- License : MIT ------------------------------------------------------------------------------