Skip to content

Commit e2165a0

Browse files
Drakweaverryan
Drak
authored andcommitted
Added some notes about Windows and colours.
1 parent fa6fdee commit e2165a0

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

components/console/introduction.rst

+10
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,15 @@ You can install the component in many different ways:
2020
* Use the official Git repository (https://github.com/symfony/Console);
2121
* :doc:`Install it via Composer</components/using_components>` (``symfony/console`` on `Packagist`_).
2222

23+
.. note::
24+
25+
Windows does not support ANSI colors by default so the Console Component detects and
26+
disables colors where Windows does not have support. However, if Windows is not
27+
configured with an ANSI driver and your console commands invoke other scripts which
28+
emit ANSI color sequences, they will be shown as raw escape characters.
29+
30+
To enable ANSI colour support for Windows, please install `ANSICON_`.
31+
2332
Creating a basic Command
2433
------------------------
2534

@@ -399,3 +408,4 @@ Learn More!
399408
* :doc:`/components/console/single_command_tool`
400409

401410
.. _Packagist: https://packagist.org/packages/symfony/console
411+
.. _ANSICON: http://adoxa.3eeweb.com/ansicon/

0 commit comments

Comments
 (0)