Skip to content

Commit

Permalink
Improve doc/build-from-source.md to warm about virtual env
Browse files Browse the repository at this point in the history
  • Loading branch information
paugier committed Nov 20, 2024
1 parent 6f82d39 commit 8f65385
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
develop: sync

sync:
pdm sync --clean
pdm sync --clean -v

lock:
pdm lock
Expand Down
23 changes: 18 additions & 5 deletions doc/build-from-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,15 +215,28 @@ pipx install pdm -U

Installing in editable mode is a bit particular with Meson, since editable installations
are incompatible with isolated builds, meaning that all build dependencies have to be
installed in the main virtual environment! Fortunatelly, it's not too difficult with
[PDM]. From the root directory of the repository, just run:
installed in the main virtual environment! Fortunatelly, it's simple with [PDM].

```{warning}
You should not run the following commands from a virtual environment not related to Fluidimage.
```

From the root directory of the repository, just run:

```sh
pdm sync --clean
```

This command creates a virtual environment, installs all build and runtime dependencies,
and finally build/install Fluidimage from source.

Alternativelly, one can split this process in two steps. First, install all dependencies:

```sh
pdm install --no-self
pdm sync --no-self --clean
```

This command creates a virtual environment and installs all build and runtime
dependencies. You can then activate this environment and build/install Fluidimage with:
You can then activate this environment and build/install Fluidimage with:

```sh
. .venv/bin/activate
Expand Down

0 comments on commit 8f65385

Please sign in to comment.