[commit: packages/directory] master: Update `README.md` (7f8fed1)

git at git.haskell.org git at git.haskell.org
Thu Mar 19 11:38:27 UTC 2015


Repository : ssh://git@git.haskell.org/directory

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/7f8fed1c688cdc3ed3b9c6954fc744ea15b8d9fc/directory

>---------------------------------------------------------------

commit 7f8fed1c688cdc3ed3b9c6954fc744ea15b8d9fc
Author: Phil Ruffwind <rf at rufflewind.com>
Date:   Tue Mar 3 16:53:52 2015 -0500

    Update `README.md`


>---------------------------------------------------------------

7f8fed1c688cdc3ed3b9c6954fc744ea15b8d9fc
 README.md | 32 ++++++++++++++++++++------------
 1 file changed, 20 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 2b1cedc..5eb5566 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,23 @@
-The `directory` Package   [![Hackage](https://img.shields.io/hackage/v/directory.svg)](https://hackage.haskell.org/package/directory) [![Build Status](https://travis-ci.org/haskell/directory.svg?branch=master)](https://travis-ci.org/haskell/directory)
-=======================
+`directory` [![Hackage][1]][2] [![Build Status][3]][4]
+===========
 
-See [`directory` on Hackage](http://hackage.haskell.org/package/directory) for
-more information.
+Documentation can be found on [Hackage][2].
 
-Installing from Git
--------------------
+Building from Git repository
+----------------------------
 
-To build this package using Cabal directly from Git, you must run
-`autoreconf -i` before the usual Cabal build steps (`cabal
-{configure,build,install}`). The program `autoreconf` is part of
-[GNU autoconf](http://www.gnu.org/software/autoconf/).  There is no
-need to run the `configure` script: `cabal configure` will do this for
-you.
+When building this package directly from the Git repository, one must run
+`autoreconf -i` to generate the `configure` script needed by `cabal
+configure`.  This requires [Autoconf][5] to be installed.
+
+    autoreconf -i
+    cabal install
+
+There is no need to run the `configure` script manually however, as `cabal
+configure` does that automatically.
+
+[1]: https://img.shields.io/hackage/v/directory.svg
+[2]: https://hackage.haskell.org/package/directory
+[3]: https://travis-ci.org/haskell/directory.svg?branch=master
+[4]: https://travis-ci.org/haskell/directory
+[5]: https://gnu.org/software/autoconf



More information about the ghc-commits mailing list