Skip to content
This repository
Newer
Older
100644 63 lines (36 sloc) 1.618 kb
b22027fe »
2010-06-18 Initial checkin of various non-code files
1 Snap Framework
2 ==============
3
4 This is the first developer prerelease of the Snap Framework snap
5 tool. For more information about Snap, read the `README.SNAP.md` or
6 visit the Snap project website at http://www.snapframework.com/.
7
8 Snap is a nascent web framework for Haskell, based on iteratee I/O (as
9 [popularized by Oleg
10 Kiselyov](http://okmij.org/ftp/Streams.html#iteratee)).
11
12
13 ## Library contents
14
15 This is the `snap` executable and supporting library, which contains:
16
17 * a command-line utility for creating initial Snap applications
18
19 * a library allowing Snap applications to recompile actions on the
20 fly in development mode, with no performance loss in production
21 mode.
22
23
24 Building snap
25 =============
26
27 The snap tool and library are built using
28 [Cabal](http://www.haskell.org/cabal/) and
29 [Hackage](http://hackage.haskell.org/packages/hackage.html). Just run
30
31 cabal install
32
33 from the `snap` toplevel directory.
34
35
36 ## Building the Haddock Documentation
37
38 The haddock documentation can be built using the supplied `haddock.sh` shell
39 script:
40
41 ./haddock.sh
42
43 The docs get put in `dist/doc/html/`.
44
45
46 ## Building the testsuite
47
48 Snap is still in its very early stages, so most of the "action" (and a big
49 chunk of the code) right now is centred on the test suite. Snap aims for 100%
50 test coverage, and we're trying hard to stick to that.
51
52 To build the test suite, `cd` into the `test/` directory and run
53
54 $ cabal configure
55 $ cabal build
56
57 From here you can invoke the testsuite by running:
58
59 $ ./runTestsAndCoverage.sh
60
61
62 The testsuite generates an `hpc` test coverage report in `test/dist/hpc`.
Something went wrong with that request. Please try again.