Skip to content

Commit 43d7766

Browse files
patrik-csakfelixfbecker
authored andcommitted
docs: improve README formatting (#253)
- Installation step 1 subitems weren't indented - Installation steps 4 and 5 were stuck to the previous paragraph
1 parent 5e5f2e7 commit 43d7766

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,10 @@ Install the extension: Press `F1`, type `ext install php-debug`.
1414
This extension is a debug adapter between VS Code and [XDebug](https://xdebug.org/) by Derick Rethan. XDebug is a PHP extension (a `.so` file on Linux and a `.dll` on Windows) that needs to be installed on your server.
1515

1616
1. [Install XDebug](https://xdebug.org/docs/install)
17-
***I highly recommend you make a simple `test.php` file, put a `phpinfo();` statement in there, then copy the output and paste it into the [XDebug installation wizard](https://xdebug.org/wizard.php). It will analyze it and give you tailored installation instructions for your environment.***
18-
In short:
19-
- On Windows: [Download](https://xdebug.org/download.php) the appropiate precompiled DLL for your PHP version, architecture (64/32 Bit), thread safety (TS/NTS) and Visual Studio compiler version and place it in your PHP extension folder.
20-
- On Linux: Either download the source code as a tarball or [clone it with git](https://xdebug.org/docs/install#source), then [compile it](https://xdebug.org/docs/install#compile).
21-
2. [Configure PHP to use XDebug](https://xdebug.org/docs/install#configure-php) by adding `zend_extension=path/to/xdebug` to your php.ini.
22-
The path of your php.ini is shown in your `phpinfo()` output under "Loaded Configuration File".
17+
***I highly recommend you make a simple `test.php` file, put a `phpinfo();` statement in there, then copy the output and paste it into the [XDebug installation wizard](https://xdebug.org/wizard.php). It will analyze it and give you tailored installation instructions for your environment.*** In short:
18+
- On Windows: [Download](https://xdebug.org/download.php) the appropiate precompiled DLL for your PHP version, architecture (64/32 Bit), thread safety (TS/NTS) and Visual Studio compiler version and place it in your PHP extension folder.
19+
- On Linux: Either download the source code as a tarball or [clone it with git](https://xdebug.org/docs/install#source), then [compile it](https://xdebug.org/docs/install#compile).
20+
2. [Configure PHP to use XDebug](https://xdebug.org/docs/install#configure-php) by adding `zend_extension=path/to/xdebug` to your php.ini. The path of your php.ini is shown in your `phpinfo()` output under "Loaded Configuration File".
2321
3. Enable remote debugging in your php.ini:
2422

2523
```ini
@@ -28,6 +26,7 @@ This extension is a debug adapter between VS Code and [XDebug](https://xdebug.or
2826
xdebug.remote_autostart = 1
2927
```
3028
There are other ways to tell XDebug to connect to a remote debugger than `remote_autostart`, like cookies, query parameters or browser extensions. I recommend `remote_autostart` because it "just works". There are also a variety of other options, like the port (by default 9000), please see the [XDebug documentation on remote debugging](https://xdebug.org/docs/remote#starting) for more information.
29+
3130
4. If you are doing web development, don't forget to restart your webserver to reload the settings
3231
5. Verify your installation by checking your `phpinfo()` output for an XDebug section.
3332

0 commit comments

Comments
 (0)