Permalink
Browse files

Updated README with some clarifications. Added some needed files to e…

…xample app
  • Loading branch information...
1 parent 80d494f commit a448f2442f17b72702da53c8c3c44b0284525384 @bergmark bergmark committed Aug 11, 2012
Showing with 11 additions and 7 deletions.
  1. +0 −2 .gitignore
  2. +7 −2 README.md
  3. +0 −2 TODO
  4. 0 example/log/access.log
  5. 0 example/log/error.log
  6. +4 −0 example/snaplets/fay/devel.cfg
  7. +0 −1 snaplet-fay.cabal
View
2 .gitignore
@@ -1,6 +1,4 @@
dist
test-dest
example/log
-example/snaplets/fay/devel.cfg
example/snaplets/fay/js
-
View
9 README.md
@@ -51,12 +51,17 @@ data App = App { _fay :: Snaplet Fay }
makeLens ''App
```
-Place your Fay .hs files in snaplets/fay/src.
+Run your application now.
-A snaplet config file will be generated in snaplets/fay/devel.cfg the
+A snaplet config file will be generated at snaplets/fay/devel.cfg the
first time your application initializes the snaplet. The defaults are
the recommended ones for development.
+Place your Fay .hs files in snaplets/fay/src. Note that a default
+devel.cfg will not be created if you have already created the fay
+directory, if this happens to you move snaplets/fay, start your
+application, and then move the files back into snaplets/fay.
+
Development Status
------------------
View
2 TODO
@@ -8,7 +8,5 @@
* 404 when a fay file doesn't exist
* Document configuration
* Why does Paths_snaplet_fay produce a warning?
-* Why is the old snaplet.cfg copied?
-* js files are not placed in fay/ instead of fay/js/
* TODO has to recompile if dependencies (imports) changed, should perhaps skip compileAll mode?
* Log messages should print relative paths
View
0 example/log/access.log
No changes.
View
0 example/log/error.log
No changes.
View
4 example/snaplets/fay/devel.cfg
@@ -0,0 +1,4 @@
+# "CompileAll" or "CompileOnDemand".
+compileMethod = "CompileOnDemand"
+# Print more or less information.
+verbose = on
View
1 snaplet-fay.cabal
@@ -38,7 +38,6 @@ library
other-modules:
Snap.Snaplet.Fay.Internal, Paths_snaplet_fay
-
build-depends:
base == 4.5.*,
bytestring == 0.9.*,

0 comments on commit a448f24

Please sign in to comment.