From 0da04d3c62fb9d9c4500f347d629f16fa12bae45 Mon Sep 17 00:00:00 2001 From: Greg Weber Date: Wed, 17 Aug 2011 08:56:18 -0700 Subject: [PATCH] better README --- yesod/README | 3 --- yesod/{development.md => README.md} | 10 ++++++++++ 2 files changed, 10 insertions(+), 3 deletions(-) delete mode 100644 yesod/README rename yesod/{development.md => README.md} (69%) diff --git a/yesod/README b/yesod/README deleted file mode 100644 index f98ab5ec..00000000 --- a/yesod/README +++ /dev/null @@ -1,3 +0,0 @@ -After installing, type "yesod init" to start a new project. - -Learn more at http://www.yesodweb.com/book diff --git a/yesod/development.md b/yesod/README.md similarity index 69% rename from yesod/development.md rename to yesod/README.md index 531621ea..c6ecbe06 100644 --- a/yesod/development.md +++ b/yesod/README.md @@ -1,3 +1,13 @@ +# Overview + +The yesod package +* groups together the various Yesod related packages into one cohesive whole. +* contains the executable yesod + +There are 2 main features of the executable +* yesod devel - star a development environment +* yesod init - create a scaffolded site + # Scaffolding ## Test suite