docs: Add note about `ccache` (#3305)

* Update `dev/environment-dev.yml`

Signed-off-by: Julien Jerphanion <git@jjerphan.xyz>

* Specify to use dev/environment-dev-extra.yml

Since is contains ccache.

Signed-off-by: Julien Jerphanion <git@jjerphan.xyz>

* Use the normal dev env and add note regarding ccache

Co-authored-by: Hind-M <Hind-M@users.noreply.github.com>

Signed-off-by: Julien Jerphanion <git@jjerphan.xyz>

* fixup! Use the normal dev env and add note regarding ccache

* Adapt notes

Co-authored-by: Hind-M <Hind-M@users.noreply.github.com>

Signed-off-by: Julien Jerphanion <git@jjerphan.xyz>

* Stop multitasking, Julien.

Signed-off-by: Julien Jerphanion <git@jjerphan.xyz>

---------

Signed-off-by: Julien Jerphanion <git@jjerphan.xyz>
This commit is contained in:
Julien Jerphanion 2024-06-07 10:30:57 +02:00 committed by GitHub
parent 56c0a8397c
commit 7e1aae7d6e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 1 deletions

View File

@ -127,7 +127,7 @@ Install development dependencies
.. code:: bash
micromamba create -n mamba -c conda-forge -f dev/environment.yml
micromamba create -n mamba -c conda-forge -f dev/environment-dev.yml
micromamba activate -n mamba
Compile ``libmamba`` and other artifacts
@ -140,6 +140,11 @@ from Conda-Forge.
The first step is to configure the build options.
A recommended set is already provided as CMake Preset, but feel free to use any variations.
.. note::
If you do choose to use the provided CMake Preset, you may need to
install ``ccache`` as an extra requirement as specified
in ``dev/environment-dev-extra.yml``.
.. note::
All ``cmake`` commands listed below use ``bash`` multi-line syntax.
On Windows, replace ``\`` trailing character with ``^``.