Skip to content

Commit

Permalink
add more documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pascalpoizat committed Feb 25, 2023
1 parent 696c7e7 commit 5abe58f
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ on:
env:
lts: 20.5
program: template-haskell-project-exe
version: 0.1.3.0
version: 0.1.4.0
jobs:
build:
name: build-${{ matrix.ghc }}-${{ matrix.stack }}-${{ matrix.os }}
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ A simple template for Haskell projects built with Stack, together with some basi

Some complementary language-independent information can be found [here](https://github.com/pascalpoizat/template-java-project) (one may have to dig among Java-specific stuff).

Note: version in the [source code](https://github.com/pascalpoizat/template-haskell-project/blob/master/src/Lib.hs), the [Cabal](https://github.com/pascalpoizat/template-haskell-project/blob/master/template-haskell-project.cabal) configuration, and the [CI workflow](https://github.com/pascalpoizat/template-haskell-project/blob/master/.github/workflows/CI.yml) (this should be automated).

## Installing the environment

The environment is made up of the [GHC compiler](https://www.haskell.org/ghc/) and a dependency manager / build tool such as [Cabal](https://cabal.readthedocs.io/en/stable/) or [Stack](https://docs.haskellstack.org/en/stable/). Haskell libraries can be found on [Hackage](https://hackage.haskell.org). Stack comes with sets of compatible libraries from Hackage organized in [Long Term Support releases](https://www.stackage.org)(LTS).
Expand Down
2 changes: 1 addition & 1 deletion src/Lib.hs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ where

-- | A sample function printing out a sample string.
someFunc :: IO ()
someFunc = putStrLn "0.1.3.3"
someFunc = putStrLn "0.1.4.0"

-- | A Point.
data Point = Point {x :: Int, y :: Int}
Expand Down
2 changes: 1 addition & 1 deletion template-haskell-project.cabal
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: template-haskell-project
version: 0.1.3.3
version: 0.1.4.0
synopsis: Initial version
description: Please see README.md
homepage: https://github.com/pascalpoizat/template-haskell-project#readme
Expand Down

0 comments on commit 5abe58f

Please sign in to comment.