diff --git a/README.md b/README.md index f945bc3..d8df689 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ Glance is a visual syntax for the programming language Haskell. The goal of this project is to increase programmer happiness and productivity by allowing programmers to understand programs in new and different ways. Currently, the Glance executable will produce a visual representation of your code in the form of an SVG image when given a textuall Haskell source file. In the future, I hope to incorporate Glance into Haskell code editors, and to eventually create a visual editor for Haskell. To build and run: + +First install Graphviz. For instance, in Ubuntu: + +```sudo apt install graphviz``` + +Then build and execute glance: ``` stack build stack exec glance-exe -- -o images/fact.svg -w 500 examples/fact.hs -