on master help sign in
Merge pull request #4 from erikd/master

Add .gitignore and add minimal build documentation

commit2bd9f46aa1df97de81548e8df2d9e735e8aff3c7 authorHuw Campbell <huw.campbell@gmail.com> dateWed 29 Jun 2016, 20:53 (10 years ago) parentb8e04504ef66b7
2 files changed+24
.gitignore+4 README.md+20
.gitignorenew file+4
@@ -0,0 +1,4 @@
1+.cabal-sandbox/
2+cabal.sandbox.config
3+dist/
4+
README.md+20
@@ -37,6 +37,26 @@ Layers in Grenade are represented as Haskell classes, so creating one's own is e
3737of a network are not specified correctly and a layer can not sensibly perform the operation between two shapes, then
3838it will result in a compile time error.
3939
40+
41+Build Instructions
42+------------------
43+Grenade currently only builds with the [mafia][https://github.com/ambiata/mafia] scipt that is located in the
44+repository. You will also need the `lapack` and `blas` libraries and development tools. Once you have all
45+that, Grenade can be build using:
46+
47+```
48+./mafia build
49+```
50+
51+and the tests run using:
52+
53+```
54+./mafia test
55+```
56+
57+Grenade is currently known to build with ghc 7.10. We are working on making it build with ghc 8.0.
58+
59+
4060Thanks
4161------
4262Writing a library like this has been on my mind for a while now, but a big shout out must go to Justin Le, whose