From 27940dc5e5b96a2247dbe65f887c52595428ddb9 Mon Sep 17 00:00:00 2001 From: apostolis anastasiou Date: Thu, 17 Dec 2020 15:48:34 +0200 Subject: [PATCH 1/2] Add description for who's the extension for --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index f989f99..05defe6 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,20 @@ See [README.md](./extension/README.md) for the readme of the extension. You can get the extension in the [marketplace](https://marketplace.visualstudio.com/items?itemName=hediet.debug-visualizer). +## Who/What is this extension for + +- **Educators** - You can easily visualize the code which makes some difficult concepts easier to understand for your students. +- **Self-teaching** - Help yourself understand and debug code +- **Research** +- **Presentation** +- **Anyone who likes fun graphs** - Seriously, who doesn't! + +## What is this extension not for + +- **Professional use** - The extension works by personalizing your code to fit the extension's requirements. + + So, that means, you might have variables that their purpose is only to be consumed by this extension, which might not be what most people might want, unless you want to go that path. :) + See [CONTRIBUTING.md](./CONTRIBUTING.md) for build instructions and implementation details. ![](./docs/doubly-linked-list-reverse-demo.gif) From e8e93096be5a205c907b57612c696e42e9f8cede Mon Sep 17 00:00:00 2001 From: apostolis anastasiou Date: Fri, 18 Dec 2020 07:59:43 +0200 Subject: [PATCH 2/2] Change description what extension is not good with Changed from professional use, to precompiled languages. --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index f989f99..77bc3c7 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,26 @@ See [README.md](./extension/README.md) for the readme of the extension. You can get the extension in the [marketplace](https://marketplace.visualstudio.com/items?itemName=hediet.debug-visualizer). +--- + +## Who/What is this extension for + +- **Educators** - You can easily visualize the code which makes some difficult concepts easier to understand for your students. +- **Self-teaching** - Help yourself understand and debug code +- **Research** +- **Presentation** +- **Anyone who likes fun graphs** - Seriously, who doesn't! + +## What is this extension not good with + +- **Ease of use with compiled languages** - There's not yet good support for pre-compiled languages. The "data extractors" of the debug-visualizer work well with JS based languages but there are no "data extractors" yet for any pre-compiled languages. + + What this means for you, is if you want to use it with pre-compiled languages, you'll have to integrate code inside your codebase; code that returns data only the **debug-visualizer** understands. + + If you're interested in helping to solve this issue, you can help by [contributing](./CONTRIBUTING.md) :) + + --- + See [CONTRIBUTING.md](./CONTRIBUTING.md) for build instructions and implementation details. ![](./docs/doubly-linked-list-reverse-demo.gif)