From 418b175148a0b12ef7934a678da4544168a9c387 Mon Sep 17 00:00:00 2001 From: "Gabriele N. Tornetta" Date: Sun, 7 Nov 2021 18:52:10 +0000 Subject: [PATCH] docs(readme): add anaconda badge and use console This change adds the Anaconda badge and uses the `console` syntax highlighting instead of the invalid `bash` --- README.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0920cf0..ae17796 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,12 @@ GitHub Actions: Tests - +
+ @@ -26,6 +27,16 @@ PyPI Downloads
+   + + + + + + + +
+ LICENSE @@ -74,7 +85,7 @@ TUI Way to Resourceful Text-based User Interfaces]. Austin TUI can be installed directly from PyPI with -~~~ bash +~~~ console pipx install austin-tui ~~~ @@ -86,7 +97,7 @@ pipx install austin-tui On macOS and Linux, Austin TUI and its dependencies (including Austin itself) can be installed via conda with -~~~ bash +~~~ console conda install -c conda-forge austin-tui ~~~ @@ -96,13 +107,13 @@ Once [Austin] 3 and Austin TUI are installed, you can start using them straight-away. If you want to launch and profile a Python script, say `myscript.py`, you can do -~~~ bash +~~~ console austin-tui python3 myscript.py ~~~ or, if `myscript.py` is an executable script, -~~~ bash +~~~ console austin-tui ./myscript.py ~~~ @@ -110,7 +121,7 @@ Like [Austin], the TUI can also attach to a running Python application. To analyse the frame stacks of all the processes of a running WSGI server, for example, get hold of the PID of the parent process and do -~~~ bash +~~~ console sudo austin-tui -Cp ~~~ @@ -222,7 +233,7 @@ Since Austin TUI uses [Austin] to collect samples, the same note applies here: As for Linux users, the use of `sudo` can be avoided by granting Austin the `cap_sys_ptrace` capability with, e.g. -~~~ +~~~ console sudo setcap cap_sys_ptrace+ep `which austin` ~~~