on dd595ab help sign in
stackage/README.md
45 lines 1.7 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.
26Build the package set
27---------------------
29As this project is just starting, we don't really have a solid set of steps. In
30general, the following set of commands should be good for getting started:
32 cabal update
33 cabal install cabal-dev
34 git clone https://github.com/fpco/stackage
35 cd stackage
36 git submodule update --init # get the Haskell Platform files
37 runghc app/stackage.hs build # takes a *long* time
38 runghc app/stackage.hs init # modifies your ~/.cabal/config file
40Notes
41-----
43Make sure to have Cabal-1.16 installed in either your global or user database,
44regardless of any sandboxing, as custom build types require it to be present.
45You must build with cabal-install 1.16, due to several important bug fixes.