Merge pull request #4 from erikd/master

Add .gitignore and add minimal build documentation
This commit is contained in:
Huw Campbell 2016-06-29 20:53:52 +10:00 committed by GitHub
commit 2bd9f46aa1
2 changed files with 24 additions and 0 deletions

4
.gitignore vendored Normal file
View File

@ -0,0 +1,4 @@
.cabal-sandbox/
cabal.sandbox.config
dist/

View File

@ -37,6 +37,26 @@ Layers in Grenade are represented as Haskell classes, so creating one's own is e
of a network are not specified correctly and a layer can not sensibly perform the operation between two shapes, then
it will result in a compile time error.
Build Instructions
------------------
Grenade currently only builds with the [mafia][https://github.com/ambiata/mafia] scipt that is located in the
repository. You will also need the `lapack` and `blas` libraries and development tools. Once you have all
that, Grenade can be build using:
```
./mafia build
```
and the tests run using:
```
./mafia test
```
Grenade is currently known to build with ghc 7.10. We are working on making it build with ghc 8.0.
Thanks
------
Writing a library like this has been on my mind for a while now, but a big shout out must go to Justin Le, whose