summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..60808fa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,6 @@
+hstyle is a code style checker for Haskell programs. So far it's just a
+quick-and-dirty implementation of a few of the simplest requirements found in
+the [Snap Framework's Haskell Style
+Guide](http://snapframework.com/docs/style-guide). In the future we hope to
+build more sophisticated checking. The ultimate goal would be an automatic
+reformatter that generates gorgeous code--but that's a hard problem.