aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDaniel Gröber <dxld@darkboxed.org>2015-08-10 08:49:59 +0200
committerDaniel Gröber <dxld@darkboxed.org>2015-08-10 08:49:59 +0200
commit6a550dc667295158c8bb01c6cb82ee5a4c97c182 (patch)
treef255cbbae3fabbc8aa399ace7156a12c6fa4d9c2 /README.md
parentcb9ef0eb54ebc8067e3adcfd8d0b1b7acd2ab12c (diff)
README
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 9 insertions, 6 deletions
diff --git a/README.md b/README.md
index 8675be9..d09b640 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,16 @@
# cabal-helper
-`cabal-helper` provides a library which wraps the internal use of executables
-to lift the restrictions imposed by linking against versions of GHC before
-`7.10`.
+`cabal-helper` provides a library which wraps the internal use of
+anexecutable to lift the restrictions imposed by linking against versions of
+GHC before `7.10`. This has the pleasant side effect of isolating the user
+from having to deal with Cabal version changes manually as `cabal-helper`
+can simply recompile it's helper program automatically as needed.
`cabal-helper` uses a wrapper executable to compile the actual cabal-helper
executable at runtime while linking against an arbitrary version of
Cabal. This runtime-compiled helper executable is then used to extract
-various bits and peices from Cabal on disk state (dist/setup-config) written
-by it's configure command.
+various bits and peices from Cabal's on disk state (dist/setup-config)
+written by it's configure command.
In addition to this the wrapper executable also supports installing any
version of Cabal from hackage in case it cannot be found in any available
@@ -20,7 +22,8 @@ Furthermore the wrapper supports one special case namely reading a state
file for Cabal itself. This is needed as Cabal compiles it's Setup.hs using
itself and not using any version of Cabal installed in any package database.
-Currently `cabal-helper` supports `Cabal >= 1.16`.
+`cabal-helper` can compile with `Cabal >= 1.14` but requires `Cabal >= 1.16`
+at runtime.
## IRC