Skip to content

Commit 6cf8f64

Browse files
committed
more links and fixes
1 parent 38a515d commit 6cf8f64

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,16 +53,18 @@ Our library is written in Haskell and uses the _Stack_ build system (see [REQUIR
5353
Instructions for installing Stack, building our library and running the demo are given in the [INSTALL.md](INSTALL.md).
5454

5555

56-
## Documentation
56+
## [Documentation][documentation]
5757

5858
A detailed documentation can be found in `docs/index.html` and can be browsed on the [Github page][documentation].
5959

6060
Some interesting code locations are:
61-
- `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:
62-
- `userFormat` (default): The perspective of the developer who is editing source code while traces are recorded in the background. This is the format used in the figures in the paper. The tool will show the presence conditions of the snapshots.
63-
- `userFormatDetailed`: A variation of `userFormat` where traces and presence conditions can be investigated seperately at the same time. Code is coloured in the colour of its feature trace while presence conditions are indicated by coloured lines on the left.
64-
- `astFormat`: Shows the abstract syntax tree of the source code with feature traces as formulas.
65-
- `tikzFormat`: Tikz export of abstract syntax trees with traces. Used for figures in the paper.
61+
- [`main`](https://pmbittner.github.io/FeatureTraceRecording/Main.html#v:main) function in [`app/Main.hs`](app/Main.hs): Here you can choose in which format source code should be displayed. Choose from:
62+
- [`userFormat`](https://pmbittner.github.io/FeatureTraceRecording/Main.html#v:userFormat) (default): The perspective of the developer who is editing source code while traces are recorded in the background. This is the format used in the figures in the paper. The tool will show the presence conditions of the snapshots.
63+
- [`userFormatDetailed`](https://pmbittner.github.io/FeatureTraceRecording/Main.html#v:userFormatDetailed): A variation of `userFormat` where traces and presence conditions can be investigated seperately at the same time. Code is coloured in the colour of its feature trace while presence conditions are indicated by coloured lines on the left.
64+
- [`astFormat`](https://pmbittner.github.io/FeatureTraceRecording/Main.html#v:astFormat): Shows the abstract syntax tree of the source code with feature traces as formulas.
65+
- [`tikzFormat`](https://pmbittner.github.io/FeatureTraceRecording/Main.html#v:tikzFormat): Tikz export of abstract syntax trees with traces. Used for figures in the paper.
66+
67+
- [`showExamples`](https://pmbittner.github.io/FeatureTraceRecording/Main.html#v:showExamples) function in [`app/Main.hs`](app/Main.hs): Here you can choose which examples to run.
6668

6769
- [`src/feature/recording/FeatureTraceRecording.hs`](src/feature/recording/FeatureTraceRecording.hs): This file includes type definitions and interfaces for feature trace recording to make it configurable (e.g., plug in custom recording functions).
6870

@@ -77,7 +79,7 @@ Some interesting code locations are:
7779
- [`src/propositions/NullPropositions.hs`](src/propositions/NullPropositions.hs): Operators for the ternary logic with `null`.
7880
We provide truthtables for the logic in [meta/Truthtable.md](meta/Truthtable.md).
7981
The implementation is based on our implementation for propositional logic in [`src/propositions/Propositions.hs`](src/propositions/Propositions.hs).
80-
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.
82+
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 demo again.
8183

8284

8385
## Please cite as

0 commit comments

Comments
 (0)