From 293d8ef290a697b67d85e3cfc9ae4b8e9b9b7749 Mon Sep 17 00:00:00 2001 From: Daniel McKnight Date: Fri, 8 Sep 2023 15:06:39 -0700 Subject: [PATCH] Update documentation --- README.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index dc7c75a..297b728 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Neon Minerva (Modular INtelligent Evaluation for a Reliable Voice Assistant) provides tools for testing skills. -Install the Iris Python package with: `pip install neon-minerva` +Install the Minerva Python package with: `pip install neon-minerva` The `minerva` entrypoint is available to interact with a bus via CLI. Help is available via `minerva --help`. @@ -18,12 +18,21 @@ pip install neon-minerva ``` ## Usage -This package provides a CLI for local testing of skills. Note that skills should -be installed before testing and testing a skill that hasn't been installed with -`pip` is not currently supported. +This package provides a CLI for local testing of skills. Skills installed with +`pip` can be specified by entrypoint, or skills cloned locally can be specified +by root directory. ### Resource Tests To test that skill resources are defined for all supported languages, `minerva test-resources ` -> - is the string entrypoint for the skill to test as specified in `setup.py` -> - is a relative or absolute path to the resource test file, usually `test_resources.yaml` \ No newline at end of file +> - is the string entrypoint for the skill to test as specified in `setup.py` OR the path to + the skill's root directory +> - is a relative or absolute path to the resource test file, usually `test_resources.yaml` + +### Intent Tests +To test that skill intents match as expected for all supported languages, +`minerva test-intents ` +> - is the string entrypoint for the skill to test as specified in `setup.py` OR the path to + the skill's root directory +> - is a relative or absolute path to the resource test file, usually `test_intents.yaml` +> - The `--padacioso` flag can be added to test with Padacioso instead of Padatious for relevant intents