Doc update

This commit is contained in:
Michael Snoyman 2014-11-24 07:50:51 +02:00
parent 4b1966473e
commit 62a037f65f
2 changed files with 8 additions and 20 deletions

View File

@ -1,17 +1,10 @@
# Overview
## yesod
The yesod package groups together the various Yesod related packages into one cohesive whole.
The yesod package groups together the various Yesod related packages into one
cohesive whole. This is the "battery loaded" version of Yesod, whereas most of
the core code lives in
[yesod-core](http://www.stackage.org/package/yesod-core/).
For the yesod executeable, see [yesod-bin](/yesod-bin)
For the yesod executable, see [yesod-bin](http://www.stackage.org/package/yesod-bin/).
# Scaffolding
## Test suite
test/run.sh
## Getting a list of scaffold files for the cabal file
It is necessary after adding a scaffolding file to add it to the list of files in the cabal file.
find scaffold -type f
Yesod is [fully documented on its website](http://www.yesodweb.com/).

View File

@ -5,12 +5,7 @@ license-file: LICENSE
author: Michael Snoyman <michael@snoyman.com>
maintainer: Michael Snoyman <michael@snoyman.com>
synopsis: Creation of type-safe, RESTful web applications.
description:
A RESTful web framework with strong compile-time guarantees of correctness. It also affords space efficient code, highly concurrent loads, and portability to many deployment backends (via the wai package), from CGI to stand-alone serving.
.
Yesod also focuses on developer productivity. Yesod integrates well with tools for all your basic web development (wai, persistent, and shakespeare/hamlet)
.
The Yesod documentation site <http://www.yesodweb.com/> has much more information, including on the supporting packages mentioned above.
description: See README.md
category: Web, Yesod
stability: Stable
cabal-version: >= 1.6