rgleichman/glance
1
1
Fork 0
mirror of https://github.com/rgleichman/glance.git synced 2024-08-17 19:00:31 +03:00
Code Issues Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Robbie Gleichman 2016-12-09 14:06:56 -08:00 committed by GitHub
parent 1a2ab66f21
commit 8b4677f787
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,9 +1,8 @@
# Glance
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.
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 produces 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:
## Building
First install Graphviz. For instance, in Ubuntu run:
```sudo apt install graphviz```
@ -13,12 +12,17 @@ stack build
stack exec glance-exe -- -o images/fact.svg -w 500 examples/fact.hs -
firefox images/fact.svg
```
The [Glance wiki](../../wiki) has a brief introduction to the code architecture.
## Issues
Glance is still in development, so for the time being, layout, routing, and icon design all have much room for improvement. Here are some specific issues:
* Text boxes may not display correctly with some SVG viewers.
* Images become very large when rendering medium to large functions.
* Only a subset of Haskell is rendered
## Getting started
Below 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 much room for improvement.
Note: Text boxes may not display correctly on Microsoft browsers.
Also, the [Glance wiki](../../wiki) has a brief introduction to the code architecture.
<img src="https://cdn.rawgit.com/rgleichman/glance/958611dde3827d650c56814f8c491ecf34f954da/examples/tutorial.svg" alt="Introduction to Glance" />