From ec096ff271cbbc095f087b59c5c47a4b82ce7965 Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Sun, 25 Aug 2024 21:59:44 +0300 Subject: [PATCH 01/23] Update README.md --- README.md | 36 +++++++++++++++++++++++++++++++----- 1 file changed, 31 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5d7bfe6..4ac97af 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,45 @@ 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. -## Installation +## :zap: Usage +Write about how to use this project. +`idd.py ...` -TODO +### :electric_plug: Installation +- Steps on how to install this project, to use it. +- Be very detailed here, For example, if you have tools which run on different operating systems, write installation steps for all of them. +``` +$ add installations steps if you have to. +$ apt-get install ... +``` ## How to use IDD -TODO + +## :cherry_blossom: Community + +If it's open-source, talk about the community here, ask social media links and other links. + + ### :fire: Contribution + + Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project. + + 1. **Report a bug**
+ If you think you have encountered a bug, and I should know about it, feel free to report it [here]() and I will take care of it. + + 2. **Request a feature**
+ You can also request for a feature [here](), and if it will viable, it will be picked for development. + + 3. **Create a pull request**
+ 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. + + > If you are new to open-source, make sure to check read more about it [here](https://www.digitalocean.com/community/tutorial_series/an-introduction-to-open-source) and learn more about creating a pull request [here](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github). ## Issues 1. Make panels scrollable 2. Make panels configurable -3. Support entering commands to a specific analyzer. \ No newline at end of file +3. Support entering commands to a specific analyzer. From 7d3e4a9a3e73f37fbc6c108f89117228c8ce3a20 Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 10:25:46 +0300 Subject: [PATCH 02/23] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 4ac97af..251ea06 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ $ apt-get install ... ## :cherry_blossom: Community If it's open-source, talk about the community here, ask social media links and other links. +![Discord Banner 4](https://discord.com/api/guilds/[SERVER ID]/widget.png?style=banner4) ### :fire: Contribution From 1ebfeb7f458ae0a0942476f713514034ef980a41 Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 11:01:55 +0300 Subject: [PATCH 03/23] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 251ea06..771fd46 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,6 @@ Write about how to use this project. $ add installations steps if you have to. $ apt-get install ... ``` -## How to use IDD - ## :cherry_blossom: Community @@ -29,16 +27,18 @@ If it's open-source, talk about the community here, ask social media links and o Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project. 1. **Report a bug**
- If you think you have encountered a bug, and I should know about it, feel free to report it [here]() and I will take care of it. + 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**
- You can also request for a feature [here](), and if it will viable, it will be picked for development. + 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**
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. > If you are new to open-source, make sure to check read more about it [here](https://www.digitalocean.com/community/tutorial_series/an-introduction-to-open-source) and learn more about creating a pull request [here](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github). +## How to use IDD + ## Issues 1. Make panels scrollable From 763bb1229e61154670a4c156d207483a0a0a550f Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 12:28:26 +0300 Subject: [PATCH 04/23] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 771fd46..87e9375 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ $ apt-get install ... ## :cherry_blossom: Community If it's open-source, talk about the community here, ask social media links and other links. -![Discord Banner 4](https://discord.com/api/guilds/[SERVER ID]/widget.png?style=banner4) +![Discord Banner 4](https://discord.com/api/guilds/1235591463472074929/widget.png?style=banner4) ### :fire: Contribution From cb9ced4e45d96fff9f210aba062cf6cca86ec39e Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 12:34:38 +0300 Subject: [PATCH 05/23] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 87e9375..5e27973 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# Introduction + IDD is a tool for performing interactive dynamic differential debugging capable to identify functional and performance regressions. ## :beginner: About From 4467994c74c01fc9cbcec7ab63ba6ceb3f0990c4 Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 12:35:03 +0300 Subject: [PATCH 06/23] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 5e27973..90198b5 100644 --- a/README.md +++ b/README.md @@ -39,8 +39,6 @@ If it's open-source, talk about the community here, ask social media links and o > If you are new to open-source, make sure to check read more about it [here](https://www.digitalocean.com/community/tutorial_series/an-introduction-to-open-source) and learn more about creating a pull request [here](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github). -## How to use IDD - ## Issues 1. Make panels scrollable From a2e9d159e904ba85ae483244b6a11a076101620a Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 12:41:11 +0300 Subject: [PATCH 07/23] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 90198b5..d824195 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,8 @@ $ apt-get install ... If it's open-source, talk about the community here, ask social media links and other links. ![Discord Banner 4](https://discord.com/api/guilds/1235591463472074929/widget.png?style=banner4) + + ### :fire: Contribution Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project. From 78434b68c54ca8f46cc951a4aa1c27a5326f72ec Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 12:45:53 +0300 Subject: [PATCH 08/23] Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index d824195..a296c93 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,9 @@ $ apt-get install ... If it's open-source, talk about the community here, ask social media links and other links. ![Discord Banner 4](https://discord.com/api/guilds/1235591463472074929/widget.png?style=banner4) +![Discord Banner 4](https://discord.com/api/guilds/1056199804956463156/widget.png?style=banner4) +![My Discord](https://discord-readme-badge.vercel.app/api?id=1235591463472074929) +![My Discord](https://discord-readme-badge.vercel.app/api?id=1056199804956463156) From 046c833dd5871c41e7e4ea9c5e404a201a3b0c2c Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 12:47:19 +0300 Subject: [PATCH 09/23] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index a296c93..1ae2ce3 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,8 @@ If it's open-source, talk about the community here, ask social media links and o ![My Discord](https://discord-readme-badge.vercel.app/api?id=1235591463472074929) ![My Discord](https://discord-readme-badge.vercel.app/api?id=1056199804956463156) +[![My Discord (YOURUSERID)](https://img.shields.io/badge/My-Discord-%235865F2.svg)](https://discord.com/users/mvassilev) + ### :fire: Contribution From ad5523860e133b68f82dbb5d6f2931fc9d03eff7 Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 12:50:05 +0300 Subject: [PATCH 10/23] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1ae2ce3..0d735ee 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,10 @@ If it's open-source, talk about the community here, ask social media links and o ![My Discord](https://discord-readme-badge.vercel.app/api?id=1235591463472074929) ![My Discord](https://discord-readme-badge.vercel.app/api?id=1056199804956463156) -[![My Discord (YOURUSERID)](https://img.shields.io/badge/My-Discord-%235865F2.svg)](https://discord.com/users/mvassilev) +[![My Discord (YOURUSERID)](https://img.shields.io/badge/My-Discord-%235865F2.svg)](https://discord.com/invite/Vkv3ne4zVK) + +![Discord Shield](https://discordapp.com/api/guilds/1056199804956463156/widget.png?style=shield) + From 0d8f45aab02f1ecc60417aa38219b654d10af6be Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 14:01:16 +0300 Subject: [PATCH 11/23] Update README.md --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0d735ee..f3143dd 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,13 @@ $ apt-get install ... ## :cherry_blossom: Community -If it's open-source, talk about the community here, ask social media links and other links. -![Discord Banner 4](https://discord.com/api/guilds/1235591463472074929/widget.png?style=banner4) +Join our discord for more updates + + + + + +![Discord Banner 4](https://discord.com/api/guilds/1235591463472074929/widget.png?style=banner4) ![Discord Banner 4](https://discord.com/api/guilds/1056199804956463156/widget.png?style=banner4) ![My Discord](https://discord-readme-badge.vercel.app/api?id=1235591463472074929) ![My Discord](https://discord-readme-badge.vercel.app/api?id=1056199804956463156) From 96fe1e426eff9bb1e799c78e984dd322a0b45523 Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 14:02:21 +0300 Subject: [PATCH 12/23] Update README.md --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f3143dd..3972c48 100644 --- a/README.md +++ b/README.md @@ -21,13 +21,9 @@ $ apt-get install ... ## :cherry_blossom: Community -Join our discord for more updates - - +Join our discord for more updates - - -![Discord Banner 4](https://discord.com/api/guilds/1235591463472074929/widget.png?style=banner4) +![Discord Banner 4](https://discord.com/api/guilds/1235591463472074929/widget.png?style=banner4) ![Discord Banner 4](https://discord.com/api/guilds/1056199804956463156/widget.png?style=banner4) ![My Discord](https://discord-readme-badge.vercel.app/api?id=1235591463472074929) ![My Discord](https://discord-readme-badge.vercel.app/api?id=1056199804956463156) From 4b655ccbe567763a90c44163d8af5ec345dd7899 Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 14:03:44 +0300 Subject: [PATCH 13/23] Add discord svg. --- images/discord.svg | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 images/discord.svg diff --git a/images/discord.svg b/images/discord.svg new file mode 100644 index 0000000..db17d73 --- /dev/null +++ b/images/discord.svg @@ -0,0 +1,8 @@ + + + + + + + + From 02ec40e4c8e0154357d15e1e31288760bf13c695 Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 14:06:35 +0300 Subject: [PATCH 14/23] Update README.md --- README.md | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 3972c48..854de0c 100644 --- a/README.md +++ b/README.md @@ -21,19 +21,9 @@ $ apt-get install ... ## :cherry_blossom: Community -Join our discord for more updates +Join our discord for discussions and collaboration. + -![Discord Banner 4](https://discord.com/api/guilds/1235591463472074929/widget.png?style=banner4) -![Discord Banner 4](https://discord.com/api/guilds/1056199804956463156/widget.png?style=banner4) -![My Discord](https://discord-readme-badge.vercel.app/api?id=1235591463472074929) -![My Discord](https://discord-readme-badge.vercel.app/api?id=1056199804956463156) - -[![My Discord (YOURUSERID)](https://img.shields.io/badge/My-Discord-%235865F2.svg)](https://discord.com/invite/Vkv3ne4zVK) - -![Discord Shield](https://discordapp.com/api/guilds/1056199804956463156/widget.png?style=shield) - - - ### :fire: Contribution From c18abdfbdcd77710dfb825c08c0b028271630da9 Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 14:07:02 +0300 Subject: [PATCH 15/23] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 854de0c..a2d5113 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,8 @@ $ apt-get install ... ## :cherry_blossom: Community -Join our discord for discussions and collaboration. +Join our discord for discussions and collaboration. + From 10d84ea4e595b14f90e32baa684f9a1346c81e65 Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 14:07:24 +0300 Subject: [PATCH 16/23] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a2d5113..6d03478 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ $ apt-get install ... Join our discord for discussions and collaboration. - + ### :fire: Contribution From 6f5dab1c28b111dcfed07f3388e06be4ce727115 Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 16:05:12 +0300 Subject: [PATCH 17/23] Update README.md --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6d03478..29691ed 100644 --- a/README.md +++ b/README.md @@ -8,15 +8,21 @@ IDD loads two versions of the same application. The first one is the base versio ## :zap: Usage Write about how to use this project. -`idd.py ...` +`python3 idd.py -c gdb -ba -ra ` ### :electric_plug: Installation - Steps on how to install this project, to use it. -- Be very detailed here, For example, if you have tools which run on different operating systems, write installation steps for all of them. +-- Creating new environment: ``` -$ add installations steps if you have to. -$ apt-get install ... +$ python3 -m venv iddenv +$ source iddenv/bin/activate +``` + + +-- Installing required packages: +``` +$ pip3 install textual textual_inputs pygdbmi ``` ## :cherry_blossom: Community From 66d588e799839417600aa3ce0dcaf026efb6b099 Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 16:27:55 +0300 Subject: [PATCH 18/23] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 29691ed..820457d 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Write about how to use this project. `python3 idd.py -c gdb -ba -ra ` ### :electric_plug: Installation -- Steps on how to install this project, to use it. +- Steps on how to install this project on Ubuntu 22.04 -- Creating new environment: ``` From 65e7d91d4a2c24b7790c548d4bee217fef72c255 Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 16:28:40 +0300 Subject: [PATCH 19/23] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 820457d..bf7f266 100644 --- a/README.md +++ b/README.md @@ -45,8 +45,6 @@ Join our discord for discussions and collaboration. 3. **Create a pull request**
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. - > If you are new to open-source, make sure to check read more about it [here](https://www.digitalocean.com/community/tutorial_series/an-introduction-to-open-source) and learn more about creating a pull request [here](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github). - ## Issues 1. Make panels scrollable From 1686ec7ec9713d55277786e5ff030576bcb85395 Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 16:35:28 +0300 Subject: [PATCH 20/23] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index bf7f266..c568f40 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ IDD loads two versions of the same application. The first one is the base versio ## :zap: Usage Write about how to use this project. + `python3 idd.py -c gdb -ba -ra ` ### :electric_plug: Installation @@ -21,6 +22,7 @@ $ source iddenv/bin/activate -- Installing required packages: + ``` $ pip3 install textual textual_inputs pygdbmi ``` From 2ab1d64e2676b81244e4250efe68bb3e345cd4e8 Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 16:51:10 +0300 Subject: [PATCH 21/23] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c568f40..5302843 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,6 @@ Join our discord for discussions and collaboration. ## 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 From 727c022828b289d81cb8d2807b969e3931884874 Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 17:32:21 +0300 Subject: [PATCH 22/23] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a8ea290..74cc6d2 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,6 @@ Join our discord for discussions and collaboration. ``` ## Issues - +1. ~~Support entering commands to a specific analyzer.~~ 2. Make panels scrollable 3. Make panels configurable From 40fa70d41b69c61e167749933ba286eaed74ddfd Mon Sep 17 00:00:00 2001 From: Martin Vassilev Date: Mon, 26 Aug 2024 17:33:12 +0300 Subject: [PATCH 23/23] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 74cc6d2..3856d35 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ IDD is a tool for performing interactive dynamic differential debugging capable 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) ## :zap: Usage