Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
NeonDaniel committed Sep 8, 2023
1 parent 19f150d commit 293d8ef
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand All @@ -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 <skill-entrypoint> <test-file>`
> - <skill-entrypoint\> is the string entrypoint for the skill to test as specified in `setup.py`
> - <test-file\> is a relative or absolute path to the resource test file, usually `test_resources.yaml`
> - <skill-entrypoint\> is the string entrypoint for the skill to test as specified in `setup.py` OR the path to
the skill's root directory
> - <test-file\> 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 <skill-entrypoint> <test-file>`
> - <skill-entrypoint\> is the string entrypoint for the skill to test as specified in `setup.py` OR the path to
the skill's root directory
> - <test-file\> 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

0 comments on commit 293d8ef

Please sign in to comment.