rgleichman/glance
1
1
Fork 0
mirror of https://github.com/rgleichman/glance.git synced 2024-08-16 18:30:36 +03:00
Code Issues Projects Releases Wiki Activity

Update links to wiki in README

Browse Source
This commit is contained in:
Robbie Gleichman 2017-01-06 20:41:07 -08:00 committed by GitHub
parent a396ec7ce3
commit e18fe61d30
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -10,8 +10,9 @@ The next steps for the project are to improve graph layout, and then to start wo
## Try it
First install Graphviz. For instance, in Ubuntu run:
```sudo apt install graphviz```
```
sudo apt install graphviz
```
Then build and execute glance:
```
@ -35,18 +36,20 @@ Glance is still in development, so for the time being, graph layout, line routin
* [Images become very spread out when rendering medium to large functions](https://github.com/rgleichman/glance/issues/1).
* Only a subset of Haskell is rendered.
## To learn more
To learn more about the project after reading this README, please check out the [Glance wiki](../../wiki).
## 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 -- examples/tutorial.hs examples/tutorial.svg 873 -c`
Also, the [Glance wiki](../../wiki) has a brief introduction to the code architecture.
<img src="https://cdn.rawgit.com/rgleichman/glance/798466004c3dfe10fd1b3b25df23e66d61ec1e87/examples/tutorial.svg" alt="Introduction to Glance" />
You should now be able to understand Glance's visual syntax. If you would like to see how visual code might be an improvement over textual code, or if you just want to see more examples, please take a look at the Glance wiki page [Advantages of Glance](../../wiki/Advantages-of-Glance)
## Thanks
A large thanks to the creators of [diagrams](http://projects.haskell.org/diagrams/), the main Haskell library used in this project.
Thank you to the [Santa Monica Haskell Users Group](https://www.meetup.com/santa-monica-haskell/) for their support and feedback.
Also thanks to the [/r/haskell](https://www.reddit.com/r/haskell/) subreddit for [reviewing a very early design of the language](https://www.reddit.com/r/haskell/comments/35swgl/review_my_introduction_to_glance_a_new_visual/).
Also thanks to the [/r/haskell](https://www.reddit.com/r/haskell/) subreddit for [reviewing a very early design of the language](https://www.reddit.com/r/haskell/comments/35swgl/review_my_introduction_to_glance_a_new_visual/).