diff --git a/docs/index.md b/docs/index.md index bbf3faf6..5404f317 100644 --- a/docs/index.md +++ b/docs/index.md @@ -68,15 +68,16 @@ Then install the `fact` package and its dependencies: poetry sync ``` -Activate the virtual environment created automatically by Poetry: +## Quick Start + +To run the included CLI: ```bash -poetry shell +poetry run fact 3 ``` -## Quick Start - -To use `fact` within your project, import the `factorial` function and execute the API like: +To use `fact` as a library within your project, import the `factorial` function and execute the +API like: *[API]: Application Programming Interface diff --git a/noxfile.py b/noxfile.py index d988915e..203e5cc9 100644 --- a/noxfile.py +++ b/noxfile.py @@ -26,7 +26,8 @@ def test(s: Session) -> None: # For some sessions, set venv_backend="none" to simply execute scripts within the existing Poetry -# environment. This requires that nox is run within `poetry shell` or using `poetry run nox ...`. +# environment. This requires that nox is run within the `poetry env activate` virtual environment +# or using `poetry run nox ...`. @session(venv_backend="none") @parametrize( "command",