Commit 6928646a authored by Alexander Berntsen's avatar Alexander Berntsen Committed by Sergei Trofimovich
Browse files

Improve README

parent 177c0174
...@@ -4,8 +4,8 @@ Gentoo Haskell project ...@@ -4,8 +4,8 @@ Gentoo Haskell project
Quickest start Quickest start
============== ==============
Haskell overlay consists of unstable software, so you Haskell overlay consists of unstable software, so you'll
you likely need to keyword everything in it:: likely need to keyword everything in it::
# install layman, if you don't have it yet: # install layman, if you don't have it yet:
emerge layman emerge layman
...@@ -29,7 +29,7 @@ It basically means: ...@@ -29,7 +29,7 @@ It basically means:
- sync overlays in layman list before the main tree sync - sync overlays in layman list before the main tree sync
- generate metadata for gentoo-haskell repo after main - generate metadata for gentoo-haskell repo after main
tree sync is done using N+1 cores tree sync is done, using N+1 cores
Getting involved Getting involved
================ ================
...@@ -38,18 +38,18 @@ Oh, hi! So you've got a couple of moments to kill and you're looking for ...@@ -38,18 +38,18 @@ 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. something to do? You've come to the right place.
There are several ways to find tasks. One is looking in our `TODO list`_. 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 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 Bugzilla. Anything from actually solving the problem, to just verifying the
report or providing more information is helpful. report, or providing more information is helpful.
To start contributing you need a working copy of the Haskell overlay, a copy 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 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 to get a copy, but in this case we'd not recommend it. Assuming you have git
emerged, run this to get your own copy of the repo:: emerged, run this to get your own copy of the repo::
git clone https://github.com/gentoo-haskell/gentoo-haskell.git 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. You need to be able to make patches, and send patches/pull requests on github.
If you are new to git try to read `some git basics`_ and drop in on If you are new to git try to read `some git basics`_ and drop in on
irc://freenode.net/gentoo-haskell to get help. irc://freenode.net/gentoo-haskell to get help.
...@@ -61,17 +61,17 @@ Introduction to Haskell Ebuilds ...@@ -61,17 +61,17 @@ Introduction to Haskell Ebuilds
=============================== ===============================
We have two kinds of ebuilds: completely manually written ones, and ones mostly We have two kinds of ebuilds: completely manually written ones, and ones mostly
generated from hackage using our custom tool `hackport`_. generated from hackage using our custom tool, `hackport`_.
Ebuilds for complex applications and libraries that take a little more care, Ebuilds for complex applications and libraries that need a little more care,
like ghc, are written by hand. like ghc, are written by hand.
The great majority, though, are `projects listed on the hackage site`_. For all 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 those packages, we can generate ebuilds that often require very little
manual tweaking. The dependencies, descriptions, etc. written in the ``.cabal`` manual tweaking. The ebuild is generated from the dependencies, descriptions,
files is used to correctly generate the ebuilds. The progress of hackage and etc., described in the project's ``.cabal`` file. The progress of hackage and
development decisions are important for gentoo haskell, which is why we keep its development decisions are important for gentoo haskell, which is why we
a close cooperation with them. keep a close cooperation with them.
To get the hackport tool, either install ``app-portage/hackport-9999`` 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 ::
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment