From a0d20fd62df07470b6033524afc00a96d156aaa5 Mon Sep 17 00:00:00 2001 From: Simon <4030857+SimonsMine@users.noreply.github.com> Date: Thu, 23 May 2024 15:17:49 +0100 Subject: [PATCH] docs(console): add note about running on Windows (#510) Added note about windows Co-authored-by: Eliza Weisman --- README.md | 13 +++++++++++++ tokio-console/README.md | 17 +++++++++++++++-- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 46255cdae..1bc606d14 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/tokio-console/README.md b/tokio-console/README.md index 8645a89ff..05e97074e 100644 --- a/tokio-console/README.md +++ b/tokio-console/README.md @@ -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 @@ -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]