Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 2 additions & 1 deletion noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down