Permalink
Browse files

Update README.rst

  • Loading branch information...
1 parent 65f612b commit ea9bc89fb08c4cb1e2da1c40185d11efb5a3957c @kini kini committed Feb 2, 2012
Showing with 35 additions and 29 deletions.
  1. +35 −29 README.rst
View
@@ -1,48 +1,54 @@
-Gentoo Haskell project intro
-****************************
+Gentoo Haskell project
+**********************
-Oh, hi!
-So you've got a couple of moments to kill and you're looking for something
-to do? You've come to the right place.
+Oh, hi! So you've got a couple of moments to kill and you're looking for
+something to do? You've come to the right place.
-There are sereval ways to find tasks, one is looking in our `TODO list <projects/doc/TODO.rst>`_.
-Another is to have a look at the bug reports piled up at
-`the Gentoo Bugzilla <http://tinyurl.com/2l3p48>`_.
-Anything from actually solving the problem to just verify the report or
-provide more information is helpful.
+There are several ways to find tasks. One is looking in our `TODO list`_.
+Another is to have a look at the `bug reports`_ piled up at the Gentoo
+Bugzilla. Anything from actually solving the problem to just verifying the
+report or providing more information is helpful.
-To start contribute you need a working copy of the haskell overlay, a copy
-that you can modify and send patches/pull requests from. You could use layman to get a
-copy, but in this case I'd not recommend it. Assuming you have git emerged,
-run this to get your own copy of the repo:
+To start contributing you need a working copy of the Haskell overlay, a copy
+that you can modify and send patches/pull requests from. You could use layman
+to get a copy, but in this case I'd not recommend it. Assuming you have git
+emerged, run this to get your own copy of the repo::
git clone https://github.com/gentoo-haskell/gentoo-haskell.git
You need to be able to create patches and send patches/pull requests on github.
-If you are new to git try to read `some basics <http://progit.org/book/>`_
-and drop on freenode://#gentoo-haskell to get help.
+If you are new to git try to read `some git basics`_ and drop in on
+irc://freenode.net/gentoo-haskell to get help.
+
+.. _TODO list: projects/doc/TODO.rst
+.. _bug reports: http://tinyurl.com/2l3p48
+.. _some git basics: http://progit.org/book/
Introduction to Haskell Ebuilds
===============================
-We have two kinds of ebuilds, completely manually written, and those mostly
-generated from hackage using our custom tool hackport.
+We have two kinds of ebuilds: completely manually written ones, and ones mostly
+generated from hackage using our custom tool `hackport`_.
Ebuilds for complex applications and libraries that take a little more care,
like ghc, are written by hand.
-The absolutely mostpart though, are projects listed on the
-`hackage site <http://hackage.haskell.org/packages/archive/pkg-list.html>`_.
-For all those packages we can generate ebuilds that often only require very
-little manual tweeking. The dependencies, descriptions etc, written in the
-``.cabal`` files is used to correctly generate the ebuilds. The progress of
-hackage and development decisions are important for gentoo haskell, which is
-why we keep a close cooperation with them.
+The great majority, though, are `projects listed on the hackage site`_. For all
+those packages, we can generate ebuilds that often only require very little
+manual tweaking. The dependencies, descriptions, etc. written in the ``.cabal``
+files is used to correctly generate the ebuilds. The progress of hackage and
+development decisions are important for gentoo haskell, which is why we keep
+a close cooperation with them.
To get the hackport tool, either install ``app-portage/hackport-9999``
-available from the haskell overlay, or get your copy of the repo using
+available from the haskell overlay, or get your copy of the repo using ::
+
+ git clone https://github.com/gentoo-haskell/hackport.git
- git clone https://github.com/gentoo-haskell/hackport.git
+See `HOWTO contribute`_ for info on technical aspects of how to work with the
+overlay.
-See `HOWTO contribute <projects/doc/HOWTO-contribute.rst>`_ on technical aspects of
-how to work with overlay.
+.. _hackport: http://github.com/gentoo-haskell/hackport
+.. _projects listed on the hackage site:
+ http://hackage.haskell.org/packages/archive/pkg-list.html
+.. _HOWTO contribute: projects/doc/HOWTO-contribute.rst

0 comments on commit ea9bc89

Please sign in to comment.