diff --git a/README.md b/README.md index 99476f2..812249a 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ # packcheck [![Hackage](https://img.shields.io/hackage/v/packcheck.svg?style=flat)](https://hackage.haskell.org/package/packcheck) -[![Gitter chat](https://badges.gitter.im/composewell/gitter.svg)](https://gitter.im/composewell/packcheck) +[![Gitter chat](https://badges.gitter.im/composewell/gitter.svg)](https://gitter.im/composewell/streamly) [![Windows Build status](https://ci.appveyor.com/api/projects/status/f7c0ncy84cxp8lbe?svg=true)](https://ci.appveyor.com/project/harendra-kumar/packcheck) [![CircleCI](https://circleci.com/gh/composewell/packcheck/tree/master.svg?style=svg)](https://circleci.com/gh/composewell/packcheck/tree/master) ## Quick Start + ### Build on CI @@ -140,13 +142,16 @@ An invocation of `packcheck.sh` performs a whole battery of tests, all aspects can be controlled via environment variables, command line. The flow goes roughly as follows: -* Pick up the correct version of GHC/cabal/stack -* create source distribution and unpack it to test from it -* run `hlint` -* build source, benchmarks and docs +* Pick or install the requested version of GHC/cabal/stack +* create source distribution package, unpack and test from it +* Check the differences in git repo and source distribution +* perform distribution checks +* build source +* build benchmarks +* build haddock docs * run tests +* run `hlint` * generate coverage report -* perform distribution checks ## Usage Examples diff --git a/packcheck.cabal b/packcheck.cabal index 43650cc..bd4251b 100644 --- a/packcheck.cabal +++ b/packcheck.cabal @@ -4,7 +4,7 @@ synopsis: Universal build and CI testing for Haskell packages description: This package contains a universal CI/build script @packcheck.sh@ and config files designed such that you can just copy over - @.github/workflows/packcheck.yml@, @appveyor.yml@ or @.circleci/config.yml@ + @.github\/workflows/packcheck.yml@, @appveyor.yml@ or @.circleci/config.yml@ to your package repo and your package is CI ready in a jiffy. You can build and test packages on local machine as well. For local testing, copy @packcheck.sh@ to your local machine, put it in your