Chore/update readme (#90)

* Updated README for better readability

* fixed kofi header

* fixed kofi header

* updated moch to run tests

* updated moch to run tests

Author: bneumann

README.md

@@ -1,42 +1,82 @@
 # CppUTest Test Adapter for Visual Studio Code
 
 [![Tests](https://github.com/bneumann/CppUTest-Test-Adapter/actions/workflows/unit_tests.yml/badge.svg?branch=master)](https://github.com/bneumann/CppUTest-Test-Adapter/actions/workflows/unit_tests.yml)
+<a href="https://ko-fi.com/B0B836FAL"><img src="img/kofi.png" width="104px"></a>
 
-This is the implementation for a [CppUTest](https://cpputest.github.io/) Test Adapter for VSCode. Check it out on the VSCode Market Place: [CppUTest Adapter](https://marketplace.visualstudio.com/items?itemName=bneumann.cpputest-test-adapter)
 
-<a href="https://ko-fi.com/B0B836FAL"><img src="img/kofi.png" height="40"></a>
+A Visual Studio Code extension that integrates the [CppUTest](https://cpputest.github.io/) C/C++ unit testing framework into VS Code's Test Explorer. Run, debug, and manage your CppUTest tests seamlessly within your development environment.
 
-![tests](img/tests.png)
+---
+
+## Features
+- **Run and debug** CppUTest tests directly from VS Code.
+- **Supports multiple test executables** and wildcards for flexible test discovery.
+- **Pre-launch tasks** to build tests before execution.
+- **Logging support** for debugging and troubleshooting.
+
+---
 
 ## Setup
 
-To let this plugin know where your tests are set the ```cpputestTestAdapter.testExecutable``` to the executable of your tests. They are separated by semicolon and support wildcards, so you can add as many executables as you want:
-```
+### 1. Configure Test Executables
+Add the following to your VS Code `settings.json` to specify your test executables:
+
+```json
 {
   "cpputestTestAdapter.testExecutable": "${workspaceFolder}/test/testrunner;${workspaceFolder}/test/subFolder/ut_*",
-  "cpputestTestAdapter.testExecutablePath": "${workspaceFolder}/test"
+  "cpputestTestAdapter.testExecutablePath": "\${workspaceFolder}/test"
 }
 ```
 
-Both settings support the ```${workspaceFolder}``` variable. The ```testExecutablePath``` determines the working directory:
-- If set to a valid directory path, all test executables will be run from this directory
-- If not set or set to an empty string, each test executable will be run from its own directory (the directory containing the executable)
+- ```testExecutable```: Path(s) to your test executables. Supports wildcards (*) and semicolon-separated lists.
+- ```testExecutablePath```: Working directory for running tests. If not set, each executable runs from its own directory.
 
-To arrange for a task to be run prior to running tests or refreshing the test list, set ```cpputestTestAdapter.preLaunchTask``` to the name of a task from tasks.json. This can be used to rebuild the test executable, for example.
+Both settings support the ```${workspaceFolder}``` variable. 
 
-### Logging Configuration
+## Pre-Launch Task (Optional)
+
+To rebuild your tests before running, define a task in tasks.json and reference it:
+```json
+{
+  "cpputestTestAdapter.preLaunchTask": "build-tests"
+}
+```
+## Logging
+Enable logging for debugging:
 
-To enable debugging and troubleshooting, configure the logging options:
 ```json
 {
   "cpputestTestAdapter.logpanel": true,
   "cpputestTestAdapter.logfile": "C:/temp/cpputest-adapter.log"
 }
 ```
+- logpanel: Shows logs in VS Code's Output panel ("CppUTest Test Adapter Log").
+- logfile: Saves logs to a file. Use absolute paths and ensure the directory exists.
 
-- ```logpanel```: Shows logs in VSCode's Output panel ("CppUTest Test Adapter Log")
-- ```logfile```: Saves logs to a file. Use absolute paths (variables like ```${workspaceFolder}``` are not supported). Create the directory beforehand if it doesn't exist.
-
-If you want to use the debugging functions you will also need to setup a launch.json file with your debugger path and arguments etc. The adapter will take care of the rest. Hopefully.
+## Debugging
+To debug your tests, configure your launch.json like you would with any debugger (in this case gdb):
 
+```json
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug CppUTest",
+      "type": "cppdbg",
+      "request": "launch",
+      "program": "${workspaceFolder}/test/testrunner",
+      "args": [],
+      "stopAtEntry": false,
+      "cwd": "${workspaceFolder}",
+      "environment": [],
+      "externalConsole": false,
+      "MIMode": "gdb",
+      "miDebuggerPath": "/path/to/gdb"
+    }
+  ]
+}
+```
+- The adapter automatically attaches to the test process.
 
+## Contributing
+Contributions are welcome! Feel free to open an issue or submit a pull request.