This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "snap-server".
The branch, master has been updated
via d1e350eefe74de60d12167a54f421f0d3addcc34 (commit)
from ca7ba77e7475537bca7f5d906b78700b180004c4 (commit)
Summary of changes:
README.md | 57 +++++++++++++++++++++++----------------------------------
1 files changed, 23 insertions(+), 34 deletions(-)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit d1e350eefe74de60d12167a54f421f0d3addcc34
Author: Gregory Collins <[email protected]>
Date: Sun Dec 19 18:34:55 2010 +0100
Update README
diff --git a/README.md b/README.md
index aa13ff2..80ed64d 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
Snap Framework HTTP Server Library
----------------------------------
-This is the first developer prerelease of the Snap Framework HTTP Server
-library. For more information about Snap, read the `README.SNAP.md` or visit
-the Snap project website at http://www.snapframework.com/.
+This is the Snap Framework HTTP Server library. For more information about
+Snap, read the `README.SNAP.md` or visit the Snap project website at
+http://www.snapframework.com/.
The Snap HTTP server is a high performance, epoll-enabled, iteratee-based web
server library written in Haskell. Together with the `snap-core` library upon
@@ -29,10 +29,16 @@ Building snap-server
To build the Snap HTTP server, you need to `cabal install` the `snap-core`
library (which should have come with this package).
-The snap-server library can optionally use the
+### Optional dependencies
+
+The `snap-server` library can optionally use the
[libev](http://software.schmorp.de/pkg/libev.html) for high-speed, O(1)
scalable socket event processing.
+If you would like SSL support, `snap-server` requires the
+[gnutls](http://www.gnu.org/software/gnutls/) library.
+
+
## Building snap-server
The snap-server library is built using [Cabal](http://www.haskell.org/cabal/)
@@ -40,11 +46,17 @@ and
[Hackage](http://hackage.haskell.org/packages/hackage.html). Just run
cabal install
-for the "stock" version of Snap or
+to get the "stock" version of Snap. If you would like to try the optional
+`libev` backend, pass the `libev` flag to `cabal install`:
cabal install -flibev
-for the libev-based backend.
+And if you would like SSL support, pass the `gnutls` flag to `cabal install`:
+
+ cabal install -fgnutls
+
+Note that the "`-flibev`" and "`-fgnutls`" flags are not mutually-exclusive,
+and if you would like you can use them together.
## Building the Haddock Documentation
@@ -59,39 +71,16 @@ The docs get put in `dist/doc/html/`.
## Building the testsuite
-Snap is still in its very early stages, so most of the "action" (and a big
-chunk of the code) right now is centred on the test suite. Snap aims for 100%
-test coverage, and we're trying hard to stick to that.
-
-To build the test suite, `cd` into the `test/` directory and run
+The `snap-server` has a fairly comprehensive test suite. To build and run it,
+`cd` into the `test/` directory and run
- $ cabal configure # for the stock backend
- $ cabal configure -flibev # for the libev backend
+ $ cabal configure # for the stock backend, or..
+ $ cabal configure -flibev # for the libev backend, and/or..
+ $ cabal configure -fgnutls # for the SSL backend
$ cabal build
From here you can invoke the testsuite by running:
$ ./runTestsAndCoverage.sh
-
The testsuite generates an `hpc` test coverage report in `test/dist/hpc`.
-
-The test `cabal` project also builds an executable called "pongserver" which is
-a test HTTP server, hardcoded to run on port 8000:
-
- $ ./dist/build/pongserver/pongserver +RTS -A4M -N4 -qg0 -qb -g1
-
-(Those are the RTS settings that give me the highest performance on my
-quad-core Linux box running GHC 6.12.1, your mileage may vary.)
-
-This server just outputs "PONG" but it is a complete example of an HTTP
-application (FIXME: currently this isn't true, we need to make pongserver run
-in the still-incomplete Snap monad):
-
- $ curl -i http://localhost:8000
- HTTP/1.1 200 OK
- Content-Length: 4
- Date: Sun, 14 Mar 2010 03:17:45 GMT
- Server: Snap/0.pre-1
-
- PONG
-----------------------------------------------------------------------
hooks/post-receive
--
snap-server
_______________________________________________
Snap mailing list
[email protected]
http://mailman-mail5.webfaction.com/listinfo/snap
