From 70178ed8a5fc5434395fb6255a04b0c71b0bfc04 Mon Sep 17 00:00:00 2001 From: Michael Snoyman Date: Thu, 29 Nov 2012 19:42:20 +0200 Subject: [PATCH] More documentation --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6f3e0190..d7a7115e 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,23 @@ the maximum range of supported compiler versions. Therefore, we avoid anything "complicated." For example, instead of using the text package, we use Strings everywhere. -Getting Started ---------------- +Get your package included +------------------------- + +In order to get your package included in the set of stable packages, you should +send a pull request against this repository. In the `Stackage.Config` module, +there's a function called `defaultStablePackages`. In general, to add a set of +packages, you would add: + + mapM_ (add "your-email-address") $ words + "package1 package2 package3" + +You can follow the examples of the other sets of packages in that function. +Once you've done this, you should confirm that your newly added packages are +compatible with the rest of stackage by building the package set. + +Build the package set +--------------------- As this project is just starting, we don't really have a solid set of steps. In general, the following set of commands should be good for getting started: