Skip to content

Commit 6633472

Browse files
odahcamfelixfbecker
authored andcommitted
docs: fix XDebug installation steps list (#312)
1 parent 047777b commit 6633472

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,27 @@ Install the extension: Press `F1`, type `ext install php-debug`.
1111

1212
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.
1313

14-
1. [Install XDebug](https://xdebug.org/docs/install)
15-
**_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:
16-
- 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.
17-
- 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).
18-
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".
19-
3. Enable remote debugging in your php.ini:
20-
21-
```ini
22-
[XDebug]
23-
xdebug.remote_enable = 1
24-
xdebug.remote_autostart = 1
25-
```
14+
1. [Install XDebug](https://xdebug.org/docs/install)
15+
**_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:
16+
17+
- 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.
18+
- 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).
19+
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".
21+
22+
3. Enable remote debugging in your `php.ini`:
23+
24+
```ini
25+
[XDebug]
26+
xdebug.remote_enable = 1
27+
xdebug.remote_autostart = 1
28+
```
29+
30+
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.
2631

27-
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.
32+
4. If you are doing web development, don't forget to restart your webserver to reload the settings.
2833

29-
4. If you are doing web development, don't forget to restart your webserver to reload the settings
30-
5. Verify your installation by checking your `phpinfo()` output for an XDebug section.
34+
5. Verify your installation by checking your `phpinfo()` output for an XDebug section.
3135

3236
### VS Code Configuration
3337

0 commit comments

Comments
 (0)