Skip to content

Commit 1cab2ad

Browse files
committed
Update BUILD.md with sub-module cloning instructions
1 parent 1fcd24d commit 1cab2ad

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

BUILD.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22

33
This project uses CMake and enforces out-of-source builds. All build artifacts are kept in a separate `build/` directory, keeping the source tree clean.
44

5+
## Cloning the Repository
6+
7+
This project uses git submodules for test data and dependencies. Clone the repository with `--recursive` to automatically fetch all submodules:
8+
9+
```bash
10+
git clone --recursive https://github.com/happycube/ld-decode.git
11+
cd ld-decode
12+
```
13+
14+
**If you already cloned without `--recursive`**, initialize and update submodules:
15+
16+
```bash
17+
git submodule update --init --recursive
18+
```
19+
520
## Quick Start
621

722
```bash

0 commit comments

Comments
 (0)