Skip to content

Commit

Permalink
Merge pull request #4 from jslorrma/jslorrma-patch-1
Browse files Browse the repository at this point in the history
docs: Update `CONTRIBUTING.md`
  • Loading branch information
jslorrma authored Aug 26, 2024
2 parents 32397d8 + 6d2f2bb commit 6fd50cb
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,25 @@ pixi install -e dev
pixi run post-install
```

> **Note**: The development environment is an incremental environment that includes the default environment (see the Pixi [documentation](https://pixi.sh/latest/reference/project_configuration/#the-environments-table) for more information).
These commands install the necessary packages, set up the pre-commit hooks, and prepare the project for development.

for the development environment. You can run
> **Note**: The development environment is an incremental environment that includes the default environment (see the Pixi [documentation](https://pixi.sh/latest/reference/project_configuration/#the-environments-table) for more information).
To just install the default environment, you can run:
```bash
pixi install
```

to install only the default environment.

> **Note**: In general you can also run `pixi install --all` to install all environments specified in the `pixi.toml` file (In this repository, it's the `default` and `dev` environment).
Verify the installation by running:

```bash
pixi list
```

You should see the packages installed in the list.

### Managing Python Dependencies with `Pixi`

`Pixi` streamlines the process of managing dependencies from both Conda and PyPI, ensuring a unified approach to dependency resolution across these ecosystems. Here's how you can efficiently manage your project's dependencies:
Expand Down

0 comments on commit 6fd50cb

Please sign in to comment.