Skip to content

Commit

Permalink
docs(console): add note about running on Windows (#510)
Browse files Browse the repository at this point in the history
Added note about windows

Co-authored-by: Eliza Weisman <eliza@elizas.website>
  • Loading branch information
SimonsMine and hawkw authored May 23, 2024
1 parent 60bcf87 commit a0d20fd
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,19 @@ Options:

```
#### running the console on windows
The console uses the UTF-8 character set to display graphs and other visual
features in the terminal. In order to display this rich terminal UI on Windows,
it's necessary to use a UTF-8-enabled terminal emulator, such as the new
[Windows Terminal](https://learn.microsoft.com/en-us/windows/terminal/install).
If you're using a terminal that supports UTF-8, make sure to explicitly call
tokio-console with the UTF-8 language flag set:
```shell
tokio-console --lang en_US.UTF-8
```
## for development
the `console-subscriber/examples` directory contains **some potentially useful
Expand Down
17 changes: 15 additions & 2 deletions tokio-console/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ use the [Tokio] runtime, this means that:
- A [compatible Tokio version][versions] must be used. Tokio v1.0 or greater is required
to use the console, and some features are only available in later versions.
See [the `console-subscriber` documentation][versions] for details.

[`tracing`]: https://crates.io/crates/tracing
[unstable]: https://docs.rs/console-subscriber/0.1/console_subscriber/#enabling-tokio-instrumentation
[versions]: https://docs.rs/console-subscriber/0.1/console_subscriber/#required-tokio-versions
Expand Down Expand Up @@ -97,12 +97,25 @@ tokio-console http://my.instrumented.application.local:6669

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

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

#### running the console on windows

The console uses the UTF-8 character set to display graphs and other visual
features in the terminal. In order to display this rich terminal UI on Windows,
it's necessary to use a UTF-8-enabled terminal emulator, such as the new
[Windows Terminal](https://learn.microsoft.com/en-us/windows/terminal/install).

If you're using a terminal that supports UTF-8, make sure to explicitly call
tokio-console with the UTF-8 language flag set:
```shell
tokio-console --lang en_US.UTF-8
```

### Tasks List

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

0 comments on commit a0d20fd

Please sign in to comment.