Skip to content

Commit

Permalink
Update DEVELOPER_GUIDE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nkaenzig authored Jan 24, 2024
1 parent 39bf98a commit 4f58b3d
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions assets/DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,18 @@
To contribute any feature to EVA, you must install from source.

1. Install package and dependency manager PDM following the instructions [here](https://pdm-project.org/latest/#other-installation-methods).
2. Run `pdm install -G "dev"` to install the development dependencies. This will create a virtual environment in `eva/.venv`.
2. Run `pdm install -G dev` to install the development dependencies. This will create a virtual environment in `eva/.venv`.
3. Run `pdm run python` to run a Python script or start an interactive Python shell within the context of the PDM-managed project environment. Alternatively, you can also activate the venv manually with `source .venv/bin/activate`.

PDM quick guide:
- `pdm lock -G:all` to generate or update the pdm.lock file including all groups.
- `pdm install -G:all` to install all groups locked in the lockfile.
- `pdm update -G:all` to update all dependencies in the lock file.
- `pdm lock -G all` to generate or update the pdm.lock file including all groups.
- `pdm install -G all` to install all groups locked in the lockfile.
- `pdm update -G all` to update all dependencies in the lock file.
- `pdm add <package-name>` to add a package.
- `pdm remove <package-name>` to remove a package.
- `pdm add -G vision <package-name>` to add a package to eva[vision].
- `pdm remove -G vision <package-name>` to remove a package from eva[vision].

For more information about managing dependencies please look [here](https://pdm-project.org/latest/usage/dependency/#manage-dependencies).

## Continuous Integration (CI)
Expand Down

0 comments on commit 4f58b3d

Please sign in to comment.