globuzma/canaille-globuzma
1
0
Fork 0
forked from Github-Mirrors/canaille
Code Pull requests Activity

doc: additional contribution instructions improvements

Browse source
This commit is contained in:
Éloi Rivard 2024-11-07 12:02:02 +01:00
parent 3c5ea2e6bb
commit d2c3c99433
No known key found for this signature in database
GPG key ID: 7EDA204EA57DD184
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.rst
View file

@ -15,12 +15,14 @@ the `bugtracker <https://gitlab.com/yaal/canaille/-/issues>`_ or the `matrix roo
Development environment
-----------------------
You can either run the demo locally or with docker.
You can either run the demo locally or with Docker.
The only tool required for local development is `uv`.
Make sure to have uv `installed on your computer <https://docs.astral.sh/uv/getting-started/installation/>`_
to be able to hack Canaille.
Some dependencies of Canaille might need to be compiled, so you probably want to check that `GCC` and `cargo` are available on your computer.
After having launched the demo you have access to several services:
- A canaille server at `localhost:5000 <http://localhost:5000>`_