Skip to content

Commit

Permalink
docs: installation details
Browse files Browse the repository at this point in the history
  • Loading branch information
lyie28 committed May 16, 2024
1 parent 660ed5e commit 7182d92
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/docs/get-started/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Installation

## Installing the latest release

You can install the latest release of `lavague` with the following command:

`pip install lavague`

This will install a core bundle of lavague packages required for usage of lavague with default configurations - you can see which packages are included in this bundle in out `pyproject.toml` file at the root of our repo.

!!! note "Optional lavague packages"

If you want to use packages not included in our default bundle, you will need to manually install the relevenat package.

For example, if you want to use a non-default context such as the Gemini context. You would need to run:

```bash
pip install lavague.contexts-gemini
```

## Installing from source

If you want to install from source, you can do so by cloning the repo and running the following command from the root of the repo:

```bash
pip install -e .
```

## Dev environment

If you plan to modify local files, we recommend you follow our [dev environment guidelines](../contributing/general.md)
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ nav:
- 🏠 Home: 'index.md'

- ⚡ Getting Started:
- Installation: 'docs/get-started/installation.md'
- Quick tour: 'docs/get-started/quick-tour.md'
# - Customization: 'docs/get-started/customization.md'

Expand Down

0 comments on commit 7182d92

Please sign in to comment.