Skip to content

Commit fa4c9f5

Browse files
docs: improve README
1 parent 0e0176a commit fa4c9f5

1 file changed

Lines changed: 18 additions & 2 deletions

File tree

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,24 @@ It is particularly useful for projects with multiple product variants, where it
1212
This projects presents a prototype of our algorithm that boosts comparison-based retroactive feature tracing.
1313
The used retroactive tracing method is heavily inspired by ECCO.
1414

15+
## Dependencies
16+
- [Java using JDK17 or newer](https://www.oracle.com/java/technologies/downloads/)
17+
- [Maven](https://maven.apache.org/)
18+
1519
## Setup Using Maven
16-
To include the TraceBoosting library in your Maven project, add the following dependency to your `pom.xml` file:
20+
Clone the repository to a directory of your choice:
21+
```sh
22+
git clone https://github.com/VariantSync/trace-boosting.git
23+
```
24+
25+
Navigate into the root of the repository and install it using [Maven](https://maven.apache.org/).
26+
```sh
27+
cd trace-boosting
28+
mvn install
29+
```
30+
31+
After installation, you can include the TraceBoosting library in your Maven project.
32+
Add the following dependency to your `pom.xml` file:
1733

1834
```xml
1935
<dependency>
@@ -30,7 +46,7 @@ To use the TraceBoosting algorithm, follow these steps:
3046
2. Iterate over the collection of variants for which traces are to be computed, creating a `ProductPassport` for each and adding it to the list.
3147
3. Instantiate the TraceBoosting algorithm with the product passports, working directory, and the supported language for tracing.
3248
4. Retrieve the list of products from the TraceBoosting instance.
33-
5. Apply the proactively collected traces to the products.
49+
5. Apply the proactively collected traces to the products by settings the mappings for the products' AST nodes.
3450
6. Compute the Main tree, which represents the merged variant AST with feature traces.
3551

3652
Here is a code snippet demonstrating how to use the TraceBoosting algorithm:

0 commit comments

Comments
 (0)