Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Initial checkin of various non-code files

  • Loading branch information...
commit b22027fe45175e6f15b0f010c0091a8346f45e4d 0 parents
Carl Howells authored
Showing with 164 additions and 0 deletions.
  1. +13 −0 .gitignore
  2. +7 −0 CONTRIBUTORS
  3. +27 −0 LICENSE
  4. +55 −0 README.SNAP.md
  5. +62 −0 README.md
13 .gitignore
@@ -0,0 +1,13 @@
+*~
+dist/
+*.tix
+.hpc
+*.prof
+*.hi
+*.o
+*.swp
+#*#
+.#*
+.DS_Store
+**/.DS_Store
+docs/templates/out
7 CONTRIBUTORS
@@ -0,0 +1,7 @@
+Doug Beardsley <mightybyte@gmail.com>
+Gregory Collins <greg@gregorycollins.net>
+Shu-yu Guo <shu@rfrn.org>
+Carl Howells <chowells79@gmail.com>
+Shane O'Brien <shane@duairc.com>
+James Sanders <jimmyjazz14@gmail.com>
+Jacob Stanley <jystic@jystic.com>
27 LICENSE
@@ -0,0 +1,27 @@
+Copyright (c) 2009, Snap Framework authors (see CONTRIBUTORS)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright notice, this
+list of conditions and the following disclaimer in the documentation and/or
+other materials provided with the distribution.
+
+Neither the name of the Snap Framework authors nor the names of its
+contributors may be used to endorse or promote products derived from this
+software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55 README.SNAP.md
@@ -0,0 +1,55 @@
+Snap Framework
+--------------
+
+This is the first developer prerelease of the Snap framework. Snap is a simple
+and fast web development framework and server written in Haskell. For more
+information or to download the latest version, you can visit the Snap project
+website at http://snapframework.com/.
+
+
+Snap Status and Features
+------------------------
+
+This developer prerelease contains only the Snap core system, namely:
+
+ * a high-speed HTTP server, with an optional high-concurrency backend using
+ the [libev](http://software.schmorp.de/pkg/libev.html) library
+
+ * a sensible and clean monad for web programming
+
+ * an xml-based templating system for generating HTML based on
+ [expat](http://expat.sourceforge.net/) (via
+ [hexpat](http://hackage.haskell.org/package/hexpat)) that allows you to
+ bind Haskell functionality to XML tags without getting PHP-style tag soup
+ all over your pants
+
+Snap currently only runs on Unix platforms; it has been tested on Linux and Mac
+OSX Snow Leopard.
+
+
+Snap Philosophy
+---------------
+
+Snap aims to be the *de facto* web toolkit for Haskell, on the basis of:
+
+ * High performance
+
+ * High design standards
+
+ * Simplicity and ease of use, even for Haskell beginners
+
+ * Excellent documentation
+
+ * Robustness and high test coverage
+
+
+Snap Roadmap
+------------
+
+Where are we going?
+
+1. First prerelease: HTTP server, monad, template system
+
+2. Second prerelease: component system with a collection of useful stock
+modules (called "Snaplets") for things like user and session management,
+caching, an administrative interface, etc.
62 README.md
@@ -0,0 +1,62 @@
+Snap Framework
+==============
+
+This is the first developer prerelease of the Snap Framework snap
+tool. For more information about Snap, read the `README.SNAP.md` or
+visit the Snap project website at http://www.snapframework.com/.
+
+Snap is a nascent web framework for Haskell, based on iteratee I/O (as
+[popularized by Oleg
+Kiselyov](http://okmij.org/ftp/Streams.html#iteratee)).
+
+
+## Library contents
+
+This is the `snap` executable and supporting library, which contains:
+
+ * a command-line utility for creating initial Snap applications
+
+ * a library allowing Snap applications to recompile actions on the
+ fly in development mode, with no performance loss in production
+ mode.
+
+
+Building snap
+=============
+
+The snap tool and library are built using
+ [Cabal](http://www.haskell.org/cabal/) and
+[Hackage](http://hackage.haskell.org/packages/hackage.html). Just run
+
+ cabal install
+
+from the `snap` toplevel directory.
+
+
+## Building the Haddock Documentation
+
+The haddock documentation can be built using the supplied `haddock.sh` shell
+script:
+
+ ./haddock.sh
+
+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
+
+ $ cabal configure
+ $ 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`.
Please sign in to comment.
Something went wrong with that request. Please try again.