Skip to content

Commit 85edaeb

Browse files
committed
Added more instructions for readme
1 parent 974d0d0 commit 85edaeb

1 file changed

Lines changed: 17 additions & 7 deletions

File tree

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,24 @@
22
This repository can be used to analyze a batch of feature models using FeatureIDE. The feature models can be of any format that is supported by FeatureIDE, namely the FeatureIDE format (xml), SXFM, UVL, and DIMACS.
33
As input a path to either a directory or a feature-model file is expected. If given a directory path, the tool computes the metrics for every feature model in the directory *recursively*.
44

5+
## Building
6+
7+
The project is built using gradle. While you can use the provided wrapper `./gradlew`, you still need to [install gradle](https://docs.gradle.org/current/userguide/installation.html) on your system.
8+
9+
For model counting, we use d4 for which we only provide a Linux binary. [Here](https://github.com/SoftVarE-Group/d4v2), we provide pre-built binaries for Windows, Mac, and Linux.
10+
511
## Usage
612
Only tested with Ubuntu 22.04LTS, binaries have to be recompiled!
713

8-
Call FeatureStepAnalysis with
9-
Mandatory argument([0]): Input path
10-
Optional Argument([1]): Analysis category: All (chosen if not set), Default, Simple, CNF, Satzilla
11-
Optional Argument([2]): Output path results
12-
Optional Argument([3]): Output path time
13-
Optional Argument([4]): Output path runstatus
14+
To run use `./gradlew run --args=<path> [OPTIONS]`
15+
16+
Available options are:
17+
* Mandatory argument([0]): Input path
18+
* Optional Argument([1]): Analysis category: All (chosen if not set), Default, Simple, CNF, Satzilla
19+
* Optional Argument([2]): Output path results
20+
* Optional Argument([3]): Output path time
21+
* Optional Argument([4]): Output path runstatus
22+
23+
An example executing all default analyses on all models in `models`:
1424

15-
to execute all analysis on all files in the given path recursively.
25+
`./gradlew run --args=models default`

0 commit comments

Comments
 (0)