more documentation

danielbinschmid · Jan 20, 2024 · fe9f22b · fe9f22b
1 parent a2043d0
commit fe9f22b
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -123,4 +123,5 @@ pytest tests/
 ## Dev 
 
 - Repository must be pulled recursively. After `git clone`, run `git submodule --init --recursive`
-- This repository runs a local pip package in folder [trajectories/trajectory_generation](./trajectories/trajectory_generation). This pip package must be kept up to date with `pip install ./trajectories/trajectory_generation` after every change in the folder [trajectories/trajectory_generation](./trajectories/trajectory_generation).
+- This repository runs a local pip package in folder [trajectories/trajectory_generation](./trajectories/trajectory_generation). This pip package must be kept up to date with `pip install ./trajectories/trajectory_generation` after every change in the folder [trajectories/trajectory_generation](./trajectories/trajectory_generation).
+- Git pull must be executed for submodules as well. Run `git pull --recurse-submodules` instead of standard 'git pull'. You can also configure your Git settings to always update submodules upon pulling: `git config --global submodule.recurse true`