Skip to content

Update readme #6

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.

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

Merged
merged 25 commits into from
Aug 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
54 changes: 44 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,54 @@
# Introduction

IDD is a tool for performing interactive dynamic differential debugging capable to identify functional and performance regressions.

## About IDD
## :beginner: About

IDD loads two versions of the same application. The first one is the base version that works as expected while the second version of the same program has a regression introduced. IDD inspects the two versions of the applications using external tools like gdb and lldb. The two applications are executed side by side and the user is allowed to dispatch commands to the underlying debuggers in order to expect their internal states and isolate the origin of the regression.

## Demo
## :rocket: Demo
![idd](https://github.com/compiler-research/idd/assets/7579600/dac1b3c6-44f0-48b2-a19d-92eb5f1d973f)

## Installation
## :zap: Usage
Write about how to use this project.

`python3 idd.py -c gdb -ba <path to base executable> -ra <path to regressed executable>`

### :electric_plug: Installation
- Steps on how to install this project on Ubuntu 22.04

-- Creating new environment:
```
$ python3 -m venv iddenv
$ source iddenv/bin/activate
```


-- Installing required packages:

```
$ pip3 install textual textual_inputs pygdbmi
```

## :cherry_blossom: Community

Join our discord for discussions and collaboration.

<a target="_blank" href="https://discord.gg/Vkv3ne4zVK"><img src="images/discord.svg" /></a>

TODO

## How to use IDD
### :fire: Contribution

TODO
Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.

1. **Report a bug** <br>
If you think you have encountered a bug, and I should know about it, feel free to report it [here](https://github.com/compiler-research/idd/issues) and we could take care of it.

2. **Request a feature** <br>
You can also request for a feature [here](https://github.com/compiler-research/idd/issues), and if it will viable, it will be picked for development.

3. **Create a pull request** <br>
It can't get better then this, your pull request will be appreciated by the community. You can get started by picking up any open issues from [here]() and make a pull request.

## Cite
```bibtex
Expand All @@ -29,7 +64,6 @@ TODO
```

## Issues

1. Make panels scrollable
2. Make panels configurable
3. Support entering commands to a specific analyzer.
1. ~~Support entering commands to a specific analyzer.~~
2. Make panels scrollable
3. Make panels configurable
8 changes: 8 additions & 0 deletions images/discord.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.