|
| 1 | +# Introduction |
| 2 | + |
1 | 3 | IDD is a tool for performing interactive dynamic differential debugging capable to identify functional and performance regressions. |
2 | 4 |
|
3 | | -## About IDD |
| 5 | +## :beginner: About |
4 | 6 |
|
5 | 7 | 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. |
6 | 8 |
|
7 | | -## Demo |
| 9 | +## :rocket: Demo |
8 | 10 |  |
9 | 11 |
|
10 | | -## Installation |
| 12 | +## :zap: Usage |
| 13 | +Write about how to use this project. |
| 14 | + |
| 15 | +`python3 idd.py -c gdb -ba <path to base executable> -ra <path to regressed executable>` |
| 16 | + |
| 17 | +### :electric_plug: Installation |
| 18 | +- Steps on how to install this project on Ubuntu 22.04 |
| 19 | + |
| 20 | +-- Creating new environment: |
| 21 | +``` |
| 22 | +$ python3 -m venv iddenv |
| 23 | +$ source iddenv/bin/activate |
| 24 | +``` |
| 25 | + |
| 26 | + |
| 27 | +-- Installing required packages: |
| 28 | + |
| 29 | +``` |
| 30 | +$ pip3 install textual textual_inputs pygdbmi |
| 31 | +``` |
| 32 | + |
| 33 | +## :cherry_blossom: Community |
| 34 | + |
| 35 | +Join our discord for discussions and collaboration. |
| 36 | + |
| 37 | +<a target="_blank" href="https://discord.gg/Vkv3ne4zVK"><img src="images/discord.svg" /></a> |
11 | 38 |
|
12 | | -TODO |
13 | 39 |
|
14 | | -## How to use IDD |
| 40 | + ### :fire: Contribution |
15 | 41 |
|
16 | | -TODO |
| 42 | + Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project. |
| 43 | + |
| 44 | + 1. **Report a bug** <br> |
| 45 | + 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. |
| 46 | + |
| 47 | + 2. **Request a feature** <br> |
| 48 | + 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. |
| 49 | + |
| 50 | + 3. **Create a pull request** <br> |
| 51 | + 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. |
17 | 52 |
|
18 | 53 | ## Cite |
19 | 54 | ```bibtex |
|
29 | 64 | ``` |
30 | 65 |
|
31 | 66 | ## Issues |
32 | | - |
33 | | -1. Make panels scrollable |
34 | | -2. Make panels configurable |
35 | | -3. Support entering commands to a specific analyzer. |
| 67 | +1. ~~Support entering commands to a specific analyzer.~~ |
| 68 | +2. Make panels scrollable |
| 69 | +3. Make panels configurable |
0 commit comments