Maintenance: Add installation instructions for binary release

Add corresponding screenshots
Embiggen .gitignore

Add `Test.hs` needed for example worksheets

Author: HeinrichApfelmus

.gitignore

@@ -1,10 +1,11 @@
 *.DS_Store
 .cabal-sandbox/
 cabal.sandbox.config
+dist/
 .stack-work
 /.dist-buildwrapper
 /.project
 /.externalToolBuilders
 *.sublime-workspace
 node_modules
-/build
+/build

README.md

@@ -9,21 +9,22 @@
 
 *HyperHaskell* is currently *Level α*.
 
-  [haskell]: https://haskell.org
-  [ghc]: https://www.haskell.org/ghc/
-  [electron]: http://electron.atom.io/
-  [stack]: https://www.haskellstack.org
-
 *HyperHaskell* looks like this:
 
   <img src="docs/screenshots/worksheet-diagrams.png" height="500">
 
 # Installation
 
-HyperHaskell is currently in a pre-release state, you have to run it from source.
+  [haskell]: https://haskell.org
+  [ghc]: https://www.haskell.org/ghc/
+  [electron]: http://electron.atom.io/
+  [stack]: https://www.haskellstack.org
+  [release]: ../../releases
 
 ## Overview
 
+*HyperHaskell* is intended to be easy to install. The easiest way to install it is to download the binary distribution. This is explained in the next subsection. However, there is a pitfall which you have to know about, and which requires knowledge of the installation structure.
+
 A HyperHaskell installation consists of two parts:
 
 1. The graphical front-end.
@@ -35,21 +36,55 @@ A HyperHaskell installation consists of two parts:
     Consists of an executable `hyper-haskell-server`,
     written in Haskell using the [GHC API][ghc],
     and a library (module) `Hyper` for visualizing and pretty printing Haskell values.
-    
+
     Both parts depend on several different Haskell packages.
     Unfortunately, the versions of the packages used to compile the executable
     and to compile the library have to be exactly the same.
-    
+
     This is why, at the moment,
     the front-end does *not* come with the back-end executable included.
     Instead, the user is asked to install the `hyper-haskell-server` back-end
     into his or her own database of Haskell packages,
     and then tell the front-end about it.
     This way, the user is free to use different package or compiler versions.
 
+## Installation of the binary distribution
+
+Installation from the binary distribution follows the structure explained above.
+
+1. [Download the graphical front-end from the latest release][release] und unpack it.
+
+    ![App](docs/screenshots/app-osx.png)
+
+    *NOTE*: At the moment, I can only provide OS X binaries, because I don't have access to other architectures. Help is appreciated!
+
+2. Install the back-end server
+
+    1. Make sure that you have a working installation of the [GHC][] Haskell compiler.
+
+    2. Install the back-end with Cabal by executing
+
+            cabal install hyper hyper-haskell-server
+
+      It is also recommended (but not necessary) that you install the additional
+      support for other popular Haskell packages, e.g. the [Diagrams][] library by
+      additionally executing
+
+            cabal install hyper-extra
+
+    3. Now you can start the front-end application and create a new worksheet, or open an existing one. Make sure that the "Interpreter Back-end" in the "Settings" section of the worksheet is set to "cabal". (The path field does not matter in this case.)
+
+        ![Settings](docs/screenshots/settings-back-end-cabal.png)
+
+        It is also possible to use [Stack][] by using `stack install`, but that is not fully explained here, only to some extend below.
+
+That's it! Happy hyper!
+
+  [diagrams]: https://github.com/diagrams
+
 ## Run from source
 
-To run HyperHaskell from source, follow these steps:
+When developing HyperHaskell itself, it is also possible to run it from source. Follow these steps:
 
 1. [Download and install Electron](http://electron.atom.io/releases/)
 
@@ -68,7 +103,7 @@ To run HyperHaskell from source, follow these steps:
         ELECTRON=/Applications/Electron.app/Contents/MacOS/Electron
 
     On Linux: ??
-    
+
     On Windows: ??
 
 4. Go into the root directory of this repository and type `make run`.
@@ -82,8 +117,8 @@ To run HyperHaskell from source, follow these steps:
 5. Use the *File* menu to open one of the example worksheets from the [worksheets](worksheets/) folder. Voilà!
 
     You can also create a new worksheet, but note that you have to set the back-end path in the "Settings" section. The path is relative to the directory where the worksheet was saved. For instance, if you run a worksheet from the [worksheets](worksheets/) directory, the path `../haskell/stack.yaml` will point to the right `hyper-haskell-server` executable. Screenshot:
-    
-    ![Settings](docs/screenshots/settings-back-end.png)
+
+    ![Settings](docs/screenshots/settings-back-end-stack.png)
 
     Note that for this setting, the `stack` utility has to be in your path. You can also set an explicit path for this utility in the "Preferences…" menu item.
 

docs/misc.md

@@ -77,6 +77,12 @@ How to create an .icns file on OS X?
 
 Application icons on OS X are stored in `.icns` files. There is a command line utility called `iconutil` that is supposed to be able to create such files, but unfortunately, it only creates garbled icons for me. No idea why. Online converters seem to work fine.
 
+How to remove color profiles from images on OS X?
+-------------------------------------------------
+
+    sips -d profile --deleteColorManagementProperties *filename*
+
+
 Haskell path information
 ------------------------
 

docs/screenshots/app-osx.png

@@ -0,0 +1 @@
+hello = "Hurray, we can load external source files!"