|
| 1 | +## Installing Stack |
| 2 | + |
| 3 | +As explained in the [REQUIREMENTS.md](REQUIREMENTS.md), the [_Stack_][stack] build system is our only installation requirement. |
| 4 | +Detailed installation instruction are given on the respective [installation webpage][stackinstall]. |
| 5 | + |
| 6 | +- Linux: You can install stack via `sudo apt-get install haskell-stack` (or `sudo pacman -S stack` if you are using pacman). |
| 7 | +Further instructions for installing stack including specific linux distributions are given [here][stackinstall]. |
| 8 | +- Windows 64-bit: Go to the [stack installation page][stackinstall]. Download and run the _Windows 64-bit Installer_. |
| 9 | +- MacOS: Please follow the instructions on the [installation webpage][stackinstall]. |
| 10 | + |
| 11 | +## Running the Demo |
| 12 | + |
| 13 | +After you installed stack, please open a terminal and navigate to the repository's directory (the directory containing this `INSTALL.md`). |
| 14 | +```shell |
| 15 | +cd <path/to/this/repository> |
| 16 | +``` |
| 17 | +Our demo prints coloured text to the terminal, so it might not be compatible with every terminal. |
| 18 | +We tested it within the Windows Terminal, Windows Powershell, Windows Subsystem for Linux (WSL), and the default terminal on Manjaro. |
| 19 | +(It might not work with Git Bash.) |
| 20 | +You can then build the library and run the demo as follows: |
| 21 | + |
| 22 | +```shell |
| 23 | +stack run |
| 24 | +``` |
| 25 | + |
| 26 | +## Expected Output |
| 27 | + |
| 28 | +The demo will run three examples as described in the [README](README.md): |
| 29 | + |
| 30 | +1. Alice's part of the motivating example shown in Figure 1 in the paper. |
| 31 | +2. Bob's part of the motivating example shown in Figure 3 in the paper. |
| 32 | +3. Examples of Edit Patterns from the Evaluation (Section 5). |
| 33 | + |
| 34 | +If you see the following output after `stack run`, the build process and execution of the demo were successful. |
| 35 | +The colours in your terminal might deviate from the following screenshots: |
| 36 | + |
| 37 | + |
| 38 | + |
| 39 | + |
| 40 | + |
| 41 | +[stack]: https://docs.haskellstack.org/en/stable/README/ |
| 42 | +[stackinstall]: https://docs.haskellstack.org/en/stable/install_and_upgrade/ |
0 commit comments