Add project description to README

This commit is contained in:
Robbie Gleichman 2016-05-28 21:59:07 -07:00
parent 24e3e23f28
commit 9eaf8c5734

View File

@ -1,5 +1,5 @@
# Glance
A visual Haskell
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:
```
@ -10,11 +10,12 @@ firefox images/fact.svg
Below is a mockup of what Glance may look like in the future
<img src="examples/factorial_goal.png" alt="factorial_goal" height="300"/>
</br>
Here is a getting started guide for Glance rendered by Glance ([source here](examples/tutorial.hs)). To generate this image run
Here is a getting started guide for Glance rendered by Glance itself ([source here](examples/tutorial.hs)). To generate this image run
`stack exec glance-exe -- -o examples/tutorial.svg -w 873 examples/tutorial.hs c`
Glance is still in development, so for the time being, layout, routing, and icon design all have room for improvement.
Glance is still in development, so for the time being, layout, routing, and icon design all have much room for improvement.
<img src="https://cdn.rawgit.com/rgleichman/glance/6e56b2e5d1d2d031eca88b08e1444b8987b242af/examples/tutorial.svg" alt="Introduction to Glance" />