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