Skip to content

Commit 2672bef

Browse files
📝 Update CONTRIBUTING.md
1 parent 1372e1d commit 2672bef

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

CONTRIBUTING.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,29 @@ Feel free to fork the repository, implement your changes and create a merge requ
88

99
## Build from source (for contributions)
1010

11+
1. Clone the repository
12+
1113
```bash
1214
git clone https://github.com/IRLL/HierarchyCraft.git
1315
```
1416

15-
Install `uv` the [rust-based extremely fast package management tool](https://docs.astral.sh/uv/getting-started/installation/).
17+
2. Install `uv`
18+
19+
`uv` is a rust-based extremely fast package management tool
20+
that we use for developement.
1621

22+
See [`uv` installation instructions](https://docs.astral.sh/uv/getting-started/installation/).
1723

18-
Install hcraft as an editable package with
24+
3. Install all dependencies in a virtual environment using uv
25+
26+
Install hcraft as an editable package with
1927
dev requirements and all other extra requirements using uv:
2028
```bash
2129
uv sync --extra gym --extra gui --extra planning --extra htmlvis
2230
```
2331

32+
4. Check installation
33+
2434
Check installation by running (fast) tests,
2535
remove the marker flag to run even slow tests:
2636
```bash

0 commit comments

Comments
 (0)