Skip to content

Commit c4ab3a6

Browse files
committed
add remark about git submodules
1 parent d564e98 commit c4ab3a6

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,17 @@ If you encounter any problems or have feature requests, please open an issue on
1010
GitHub. If you need assistance related to the contents of this repository,
1111
please ask in the [project forums](https://forum.openbikesensor.org).
1212

13+
## Cloning
14+
If you want to build your own case using openscad instead of using the
15+
readymade exports or if you want to start the customizer be aware
16+
that you need to clone including git submodules:
17+
18+
```
19+
git clone --recursive https://github.com/openbikesensor/OpenBikeSensor3DPrintableCase
20+
# ... or if you forgot the --recursive argument, you can run this in the
21+
# repository's directory later:
22+
git submodule update --init --recursive
23+
```
1324

1425
## About the files
1526

@@ -349,9 +360,11 @@ OpenSCAD is a special case of course: Here submitting `.stl` (for now) and the
349360

350361
### Customizer webservice
351362

352-
To run the customizer webservice you run it from the dockerfile:
363+
To run the customizer webservice you run it from the dockerfile (and be sure
364+
that you cloned the repo recursively before building the cointainer:
353365

354366
```
367+
git submodule update --init --recursive
355368
docker build . -t customizer
356369
docker run --rm -p 8001:80 customizer
357370
```

0 commit comments

Comments
 (0)