Add how to debug docs and recommended versions

sngular · Oct 13, 2023 · f82173a · f82173a
1 parent 901de81
commit f82173a
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 1 deletion.
diff --git a/docs/debuging.md b/docs/debuging.md
@@ -0,0 +1,32 @@
+# Debuging
+
+This guide helps you debug KLoadGen in plugin mode with an IDE.
+
+## Using IntelliJ IDEA
+
+- Create a remote JVM configuration, should look like this:
+
+![debug-configuration.png](images%2Fdebug-configuration.png)
+
+- Now copy the Command line argument.
+
+## - Windows
+
+Open the file: `apache-jmeter-<version>\bin\jmeter.bat` whit any editor and paste the command on this 2 lines:
+
+![debug-jmeter-bat.png](images%2Fdebug-jmeter-bat.png)
+
+
+## - MacOS
+
+Open the file: `apache-jmeter-<version>\bin\jmeter.sh` whit any editor and paste the command on this line:
+
+![debug-jmeter-sh.png](images%2Fdebug-jmeter-sh.png)
+
+
+## While Debuging
+
+Now you can debug while you ejecute Jmeter.
+
+Remember to create a new `kloadgen-<version>.jar` file and move it to Jmeter files, to apply
+the changes you made in the code.
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -6,8 +6,10 @@ Now that you know what KLoadGen is and that you are familiar with its components
 
 You will need these tools to start using the plugin:
 
-- JDK/JRE 11+
+- JDK/JRE 11+ 
+  - (17 recommended)
 - JMeter 5.4+
+  - (5.6.2 recommended)
 - Maven
 
 ## Quickstart

diff --git a/docs/images/debug-configuration.png b/docs/images/debug-configuration.png
diff --git a/docs/images/debug-jmeter-bat.png b/docs/images/debug-jmeter-bat.png
diff --git a/docs/images/debug-jmeter-sh.png b/docs/images/debug-jmeter-sh.png