Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 55 lines (40 sloc) 2.361 kb
ea9bc89 @kini Update README.rst
kini authored
1 Gentoo Haskell project
2 **********************
2f7e5fb @trofi doc: split TODO to some pieces. moved README.rst to toplevel dir
trofi authored
3
ea9bc89 @kini Update README.rst
kini authored
4 Oh, hi! So you've got a couple of moments to kill and you're looking for
5 something to do? You've come to the right place.
2f7e5fb @trofi doc: split TODO to some pieces. moved README.rst to toplevel dir
trofi authored
6
ea9bc89 @kini Update README.rst
kini authored
7 There are several ways to find tasks. One is looking in our `TODO list`_.
8 Another is to have a look at the `bug reports`_ piled up at the Gentoo
9 Bugzilla. Anything from actually solving the problem to just verifying the
10 report or providing more information is helpful.
2f7e5fb @trofi doc: split TODO to some pieces. moved README.rst to toplevel dir
trofi authored
11
ea9bc89 @kini Update README.rst
kini authored
12 To start contributing you need a working copy of the Haskell overlay, a copy
13 that you can modify and send patches/pull requests from. You could use layman
14 to get a copy, but in this case I'd not recommend it. Assuming you have git
15 emerged, run this to get your own copy of the repo::
2f7e5fb @trofi doc: split TODO to some pieces. moved README.rst to toplevel dir
trofi authored
16
17 git clone https://github.com/gentoo-haskell/gentoo-haskell.git
18
19 You need to be able to create patches and send patches/pull requests on github.
ea9bc89 @kini Update README.rst
kini authored
20 If you are new to git try to read `some git basics`_ and drop in on
21 irc://freenode.net/gentoo-haskell to get help.
22
23 .. _TODO list: projects/doc/TODO.rst
24 .. _bug reports: http://tinyurl.com/2l3p48
25 .. _some git basics: http://progit.org/book/
2f7e5fb @trofi doc: split TODO to some pieces. moved README.rst to toplevel dir
trofi authored
26
27 Introduction to Haskell Ebuilds
28 ===============================
29
ea9bc89 @kini Update README.rst
kini authored
30 We have two kinds of ebuilds: completely manually written ones, and ones mostly
31 generated from hackage using our custom tool `hackport`_.
2f7e5fb @trofi doc: split TODO to some pieces. moved README.rst to toplevel dir
trofi authored
32
33 Ebuilds for complex applications and libraries that take a little more care,
34 like ghc, are written by hand.
35
ea9bc89 @kini Update README.rst
kini authored
36 The great majority, though, are `projects listed on the hackage site`_. For all
37 those packages, we can generate ebuilds that often only require very little
38 manual tweaking. The dependencies, descriptions, etc. written in the ``.cabal``
39 files is used to correctly generate the ebuilds. The progress of hackage and
40 development decisions are important for gentoo haskell, which is why we keep
41 a close cooperation with them.
2f7e5fb @trofi doc: split TODO to some pieces. moved README.rst to toplevel dir
trofi authored
42
43 To get the hackport tool, either install ``app-portage/hackport-9999``
ea9bc89 @kini Update README.rst
kini authored
44 available from the haskell overlay, or get your copy of the repo using ::
45
46 git clone https://github.com/gentoo-haskell/hackport.git
2f7e5fb @trofi doc: split TODO to some pieces. moved README.rst to toplevel dir
trofi authored
47
ea9bc89 @kini Update README.rst
kini authored
48 See `HOWTO contribute`_ for info on technical aspects of how to work with the
49 overlay.
2f7e5fb @trofi doc: split TODO to some pieces. moved README.rst to toplevel dir
trofi authored
50
ea9bc89 @kini Update README.rst
kini authored
51 .. _hackport: http://github.com/gentoo-haskell/hackport
52 .. _projects listed on the hackage site:
53 http://hackage.haskell.org/packages/archive/pkg-list.html
54 .. _HOWTO contribute: projects/doc/HOWTO-contribute.rst
Something went wrong with that request. Please try again.