From 3f89ea7dc7f7cb0c83fb92cb4bf17068385b4c7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20Sch=C3=A4fer?= <pschaefer@ITA.AKUSTIK.RWTH-AACHEN.DE> Date: Wed, 20 Nov 2024 12:20:42 +0100 Subject: [PATCH] README - Examples: improve docu --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d5cb4ac..09794a7 100644 --- a/README.md +++ b/README.md @@ -35,16 +35,15 @@ This way, the Python commands will be comparable to the commands of VAMatlab. This binding includes examples that demonstrate how to use the API. These can be found in the `examples` directory of the package. -When VAPython is installed, the examples can be run like this: - +When VAPython is installed, a list of examples can be shown using the example runner: ```bash -python -m vapython.examples.<example_name> +python -m vapython.examples ``` +By entering the respective number, one of the examples can be selected and executed. -Or via the included example runner: - +Alternatively, a specific example can be run using the respective name: ```bash -python -m vapython.examples.__main__ +python -m vapython.examples.<example_name> ``` ## Development guide -- GitLab