Repository : ssh://[email protected]/binary On branch : ghc-head Link : http://git.haskell.org/?p=packages/binary.git;a=commit;h=679a4a87efc4bd8c9c98d3c14c0f655385d4f1f4
>--------------------------------------------------------------- commit 679a4a87efc4bd8c9c98d3c14c0f655385d4f1f4 Author: Lennart Kolmodin <[email protected]> Date: Sat Apr 20 13:33:21 2013 +0400 Updates to the README. How to build, and why you probably don't need to. >--------------------------------------------------------------- 679a4a87efc4bd8c9c98d3c14c0f655385d4f1f4 README.md | 33 ++++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index dd29fb8..0d6f294 100644 --- a/README.md +++ b/README.md @@ -8,23 +8,34 @@ ByteStrings. A key feature of ``binary`` is that the interface is both pure, and efficient. The ``binary`` package is portable to GHC and Hugs. -## Building binary ## - -To build binary you can run the following commands in the binary package -folder. +## Installing binary from Hackage ## - $ runhaskell Setup.lhs configure - $ runhaskell Setup.lhs build - $ runhaskell Setup.lhs install +``binary`` is part of The Glasgow Haskell Compiler (GHC) and therefore if you +have either GHC or [The Haskell Platform](http://www.haskell.org/platform/) +installed, you already have ``binary``. -If you have ``cabal-install`` installed you can also install the ``binary`` -package using it. +More recent versions of ``binary`` than you might have installed may be +available. You can use ``cabal-install`` to install a later version from +[Hackage](http://hackage.haskell.org/package/binary). $ cabal update $ cabal install binary -These commands will update your cabal database and install the latest version -of ``binary`` released on Hackage. +## Building binary ## + +``binary`` comes with both a test suite and a set of benchmarks. +While developing, you probably want to enable both. +Here's how to get the latest version of the repository, configure and build. + + $ git clone [email protected]:kolmodin/binary.git + $ cd binary + $ cabal update + $ cabal configure --enable-tests --enable-benchmarks + $ cabal build + +Run the test suite. + + $ cabal test ## Using binary ## _______________________________________________ ghc-commits mailing list [email protected] http://www.haskell.org/mailman/listinfo/ghc-commits
