Skip to content

Add mention about the workflow to README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PLukas2018 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add mention about the workflow to README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,29 @@
Repositories (MSR), data showcase, pp. 610-614, 2021.
- Dataset is available from <https://github.com/shrBadihi/EqBench>.

## Running using GitHub workflow

## Requirements
> [!NOTE]
> You may need to first fork this repository to be able to run the workflow.

You can use the provided [workflow](https://github.com/diffkemp/EqBench-workflow/actions/workflows/analysis.yml)
to evaluate the correctness of DiffKemp's analysis on the programs in the
EqBench dataset. The workflow can be manually triggered from the GitHub website.
You will need to specify the repository/fork containing DiffKemp and the branch
to be used for running the dataset. The evaluation results will be reported in
the workflow summary.

## Running locally

### Requirements

To use the scripts you need to install python requirements:

```bash
pip install -r requirements.txt
```

## Usage
### Usage

Firstly, you need to clone this repo to diffkemp repository.
Then you can run the EqBench analysis like this (takes approximately 15 min):
Expand Down