git.iko.soy/stackage
on 02809df help sign in
stackage/README.md
66 lines 2.6 kB history raw
1stackage
2========
4"Stable Hackage," tools for creating a vetted set of packages from Hackage.
6A note about the codebase: the goal is to minimize dependencies and have
7the maximum range of supported compiler versions. Therefore, we avoid
8anything "complicated." For example, instead of using the text package,
9we use Strings everywhere.
11Get your package included
12-------------------------
14In order to get your package included in the set of stable packages, you should
15send a pull request against this repository. In the `Stackage.Config` module,
16there's a function called `defaultStablePackages`. In general, to add a set of
17packages, you would add:
19 mapM_ (add "your-email-address") $ words
20 "package1 package2 package3"
22You can follow the examples of the other sets of packages in that function.
23Once you've done this, you should confirm that your newly added packages are
24compatible with the rest of stackage by building the package set.
26You should also read the [maintainers
27agreement](https://github.com/fpco/stackage/wiki/Maintainers-Agreement).
29Build the package set
30---------------------
32As this project is just starting, we don't really have a solid set of steps. In
33general, the following set of commands should be good for getting started:
35 cabal update
36 cabal install cabal-dev
37 git clone https://github.com/fpco/stackage
38 cd stackage
39 git submodule update --init # get the Haskell Platform files
40 runghc app/stackage.hs select
41 runghc app/stackage.hs check
42 runghc app/stackage.hs build # takes a *long* time
43 runghc app/stackage.hs test # also takes a *long* time
45Notes
46-----
48Make sure to have Cabal-1.16 installed in either your global or user database,
49regardless of any sandboxing, as custom build types require it to be present.
50You must build with cabal-install 1.16, due to several important bug fixes.
52Using a non-Haskell Platform versions of GHC
53--------------------------------------------
55By default, Stackage bases itself off of the Haskell Platform for determining
56which packages are core packages, and locks down package versions to match the
57Haskell Platform selections. This works fine when you are compiling with the
58same version of GHC as the Haskell Platform was built on. If you're using a
59different version of GHC, you'll probably need to use the following options for
60the `select` call:
62 --no-platform --use-global-db
64The former says to disregard Haskell Platform package versions, and the latter
65says to determine which packages are core packages based on their presence in
66the global package database.