Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #510

Merged
merged 6 commits into from
May 23, 2024
Merged

Update README.md #510

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e9c16e7
Update README.md
SimonsMine Jan 20, 2024
d73653b
Update README.md
SimonsMine Jan 21, 2024
5cbc6c0
Update README.md
SimonsMine Feb 5, 2024
db0af69
pr suggestions on wording
SimonsMine Feb 5, 2024
f7de2fe
moved section, fixed typo
SimonsMine Feb 5, 2024
1fe052b
test: fix broken test
Rustin170506 May 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading