Skip to content

Commit 61226bc

Browse files
committed
added meta files for submission
1 parent 5502504 commit 61226bc

4 files changed

Lines changed: 64 additions & 1 deletion

File tree

INSTALL.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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+
![Alice](meta/Alice.png)
38+
![Bob](meta/Bob.png)
39+
![Patterns](meta/Patterns.png)
40+
41+
[stack]: https://docs.haskellstack.org/en/stable/README/
42+
[stackinstall]: https://docs.haskellstack.org/en/stable/install_and_upgrade/

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ By default, the following examples are executed in this order:
5858

5959
## Documentation
6060

61-
A detailed documentation can be found in 'docs/index.html' and can be browsed on the [Github page][documentation].
61+
A detailed documentation can be found in `docs/index.html` and can be browsed on the [Github page][documentation].
6262

6363
Some interesting code locations are:
6464
- `showExamples` function in [`app/Main.hs`](app/Main.hs): Here you can choose which examples to run and in which format the source code should be displayed. Choose from:

REQUIREMENTS.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Hardware Requirements
2+
None
3+
4+
## Software Requirements
5+
6+
The [Stack build system][stack] is the only requirement to build our library and to run the demo.
7+
Stack is the de-facto standard for Haskell projects.
8+
Dependencies to other packages are documented in the build files ([stack.yaml](stack.yaml) and [package.yaml](package.yaml)) and are handled automatically by Stack.
9+
We do not require specific operating systems or other environments apart from Stack.
10+
We successfully tested building the library and running the library on Windows 10, WSL, Ubuntu and Manjaro.
11+
12+
[stack]: https://docs.haskellstack.org/en/stable/README/

STATUS.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
We claim the _Artifacts Available_ badge as we made our artefacts publicly available on [Github][ftrgithub] and [Zenodo][ftrzenodo]. (For now, the Zenodo link points to a reserved doi under which we will publish the artifacts once completed until the deadline at June 4.)
2+
3+
We claim the _Artifacts Evaluated Reusable_ badge as we implemented feature trace recording as a reusable library.
4+
We documented all modules of the library in detail and made the documentation [available on Github][documentation] as well.
5+
Furthermore, our library serves as a reference implementation if researchers or practitioners want to reimplement feature trace recording in another programming language.
6+
7+
[ftrgithub]: https://github.com/pmbittner/FeatureTraceRecording/tree/esecfse21
8+
[ftrzenodo]: https://doi.org/10.5281/zenodo.4818461
9+
[documentation]: https://pmbittner.github.io/FeatureTraceRecording/

0 commit comments

Comments
 (0)