Skip to content

Commit 13f8c99

Browse files
committed
updated links in README
1 parent 61b2e97 commit 13f8c99

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Feature Trace Recording
22

33
[![Language](https://img.shields.io/badge/Language-Haskell-purple)](https://www.haskell.org/)
4-
[![Documentation](https://img.shields.io/badge/Documentation-Read-purple)](docs/html/index.html)
4+
[![Documentation](https://img.shields.io/badge/Documentation-Read-purple)][documentation]
55
[![License](https://img.shields.io/badge/License-GNU%20LGPLv3-blue)](https://choosealicense.com/licenses/lgpl-3.0/)
66

77
Artifact repository for the paper _Feature Trace Recording_, accepted at _ESEC/FSE 2021_.
@@ -50,15 +50,15 @@ By default, the following examples are executed in this order:
5050
2. Examples of Edit Patterns from the Evaluation (Section 5): For each pattern we show how to reproduce it in the general case and when an outer scope (eg., a method) is already assigned the target mapping. We omitted AddIfdef* as it is just a repitition of AddIfdef with arbitrary contexts and code fragments. As AddIfdefElse has to be reproduced using two variants, we need two different examples here, one for the if-branch and one for the else-branch.
5151

5252
## If You Cannot Get it Running ...
53-
..., you can find screenshots of the demo's output in the docs folder:
53+
..., you can find screenshots of the demo's output in the `meta` folder:
5454

55-
- [docs/Alice.png](docs/Alice.png): Shows the output for Figure 1 in the paper. Alice performs several edits to the `pop` method.
56-
- [docs/Bob.png](docs/Bob.png): Shows how synchronising Alice's changes to Bob's variant would look like. As the synchronisation of code and feature traces across clones is subject to future work, this example simulates how we envision the synchronisation.
57-
- [docs/Patterns.png](docs/Patterns.png): Shows how our tool can reproduce the edit patterns described in the paper.
55+
- [meta/Alice.png](meta/Alice.png): Shows the output for Figure 1 in the paper. Alice performs several edits to the `pop` method.
56+
- [meta/Bob.png](meta/Bob.png): Shows how synchronising Alice's changes to Bob's variant would look like. As the synchronisation of code and feature traces across clones is subject to future work, this example simulates how we envision the synchronisation.
57+
- [meta/Patterns.png](meta/Patterns.png): Shows how our tool can reproduce the edit patterns described in the paper.
5858

5959
## Documentation
6060

61-
A detailed documentation can be found in [docs/html/index.html](docs/html/index.html).
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:
@@ -78,7 +78,7 @@ Some interesting code locations are:
7878
- [`app/examples/`](app/examples/): In this directory, the source code for the examples can be found. The motivating example from the paper is implemented in [`StackPopAlice.hs`](app/examples/StackPopAlice.hs) and [`StackPopBob.hs`](app/examples/StackPopBob.hs). The reproduction of the edit patterns used in our evaluation can be found in [`EditPatterns.hs`](app/examples/EditPatterns.hs).
7979

8080
- [`src/propositions/NullPropositions.hs`](src/propositions/NullPropositions.hs): Operators for the ternary logic with `null`.
81-
We provide truthtables for the logic in [docs/Truthtable.md](docs/Truthtable.md).
81+
We provide truthtables for the logic in [meta/Truthtable.md](meta/Truthtable.md).
8282
The implementation is based on our implementation for propositional logic in [`src/propositions/Propositions.hs`](src/propositions/Propositions.hs).
8383
You can inspect the truth tables for the ternary logic by uncommenting the respective line (`showTruthtables`) in the `main` function in [`app/Main.hs`](app/Main.hs) and running the project again.
8484

@@ -88,4 +88,6 @@ You can inspect the truth tables for the ternary logic by uncommenting the respe
8888
[thomas]: https://www.uni-ulm.de/in/sp/team/thuem/
8989
[timo]: https://www.informatik.hu-berlin.de/de/forschung/gebiete/mse/mitarb/kehrerti.html
9090
[jeffrey]: https://www.uni-ulm.de/in/sp/team/former-employees-and-doctorands/jeffrey-young/
91-
[lukas]: https://www.tu-braunschweig.de/isf/team/lukas-linsbauer
91+
[lukas]: https://www.tu-braunschweig.de/isf/team/lukas-linsbauer
92+
93+
[documentation]: https://pmbittner.github.io/FeatureTraceRecording/

0 commit comments

Comments
 (0)