Skip to content

Commit a0d20fd

Browse files
SimonsMinehawkw
andauthored
docs(console): add note about running on Windows (#510)
Added note about windows Co-authored-by: Eliza Weisman <[email protected]>
1 parent 60bcf87 commit a0d20fd

File tree

2 files changed

+28
-2
lines changed

2 files changed

+28
-2
lines changed

README.md

+13
Original file line numberDiff line numberDiff line change
@@ -330,6 +330,19 @@ Options:
330330
331331
```
332332
333+
#### running the console on windows
334+
335+
The console uses the UTF-8 character set to display graphs and other visual
336+
features in the terminal. In order to display this rich terminal UI on Windows,
337+
it's necessary to use a UTF-8-enabled terminal emulator, such as the new
338+
[Windows Terminal](https://learn.microsoft.com/en-us/windows/terminal/install).
339+
340+
If you're using a terminal that supports UTF-8, make sure to explicitly call
341+
tokio-console with the UTF-8 language flag set:
342+
```shell
343+
tokio-console --lang en_US.UTF-8
344+
```
345+
333346
## for development
334347
335348
the `console-subscriber/examples` directory contains **some potentially useful

tokio-console/README.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ use the [Tokio] runtime, this means that:
6262
- A [compatible Tokio version][versions] must be used. Tokio v1.0 or greater is required
6363
to use the console, and some features are only available in later versions.
6464
See [the `console-subscriber` documentation][versions] for details.
65-
65+
6666
[`tracing`]: https://crates.io/crates/tracing
6767
[unstable]: https://docs.rs/console-subscriber/0.1/console_subscriber/#enabling-tokio-instrumentation
6868
[versions]: https://docs.rs/console-subscriber/0.1/console_subscriber/#required-tokio-versions
@@ -97,12 +97,25 @@ tokio-console http://my.instrumented.application.local:6669
9797

9898
See [here][cli-ref] for a complete list of all command-line arguments.
9999

100-
Tokio Console has a numnber of different views:
100+
Tokio Console has a number of different views:
101101
* [Tasks List](#tasks-list)
102102
* [Task Details](#task-details)
103103
* [Resources List](#resources-list)
104104
* [Resource Details](#resource-details)
105105

106+
#### running the console on windows
107+
108+
The console uses the UTF-8 character set to display graphs and other visual
109+
features in the terminal. In order to display this rich terminal UI on Windows,
110+
it's necessary to use a UTF-8-enabled terminal emulator, such as the new
111+
[Windows Terminal](https://learn.microsoft.com/en-us/windows/terminal/install).
112+
113+
If you're using a terminal that supports UTF-8, make sure to explicitly call
114+
tokio-console with the UTF-8 language flag set:
115+
```shell
116+
tokio-console --lang en_US.UTF-8
117+
```
118+
106119
### Tasks List
107120

108121
When the console CLI is launched, it displays a list of all [asynchronous tasks]

0 commit comments

Comments
 (0)