Permalink
Browse files

Updates the README dependencies section.

  • Loading branch information...
1 parent 6d28c58 commit e53797ad7030ca7afcc3b9880b19e3081f066ba7 @Laar committed Mar 27, 2013
Showing with 17 additions and 10 deletions.
  1. +17 −10 README.md
View
@@ -139,13 +139,20 @@ The `RawModule`s are used to generate to forms of output.
(`exposed-modules` in cabal) in `modulesE.txt`.
-#### Dependencies
-The generator depends on several packages.
-The special ones are
-
-* `haskell-src-exts` for representing the source code.
-* `CodeGenerating` to add extra functions to `haskell-src-exts` for
- generating source code, it can be found [here][codegen]
-* `opengl-api` [from noteed][parser] for parsing the spec files.
-
-[codegen]:https://github.com/Laar/CodeGenerating
+### Dependencies
+The generator has some quite some dependencies, of which some are
+managed by using git submodules. The current submodules are
+
+* `CodeGenerating` to add some extra functions to `haskell-src-exts` for
+ generating source code.
+* `opengl-api` the [parser][parser] from noteed, which needs to be
+ patched for the latest version of the spec files.
+* `OpenGLRawgenBase` basic types also used in the interface, which could
+ be used without the generator.
+
+To simplify the installation (for both
+users and travis CI) there is a dependecy installation script
+`depsinstall.sh`. This should be invoked with your favorite cabal
+command e.g. `./depsinstall.sh cabal` or `./depsinstall.sh cabal-dev`.
+Doing so will update the git submodules and install all the
+dependencies.

0 comments on commit e53797a

Please sign in to comment.