Skip to content

Commit a8b1c84

Browse files
committed
docs: update README steps for clarity in cloning and building instructions
1 parent e96e2c4 commit a8b1c84

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,23 @@ Build the library, install the Python codegen package, and run the full test
2525
suite:
2626

2727
```bash
28-
# 1. Clone with submodules
29-
git clone --recurse-submodules https://github.com/Artlesbol/FlagFFT-dev.git
28+
# 1. Clone
29+
git clone https://github.com/Artlesbol/FlagFFT-dev.git
3030
cd FlagFFT-dev
3131

32-
# 2. Build the library, CLI, and test binaries
32+
# 2. Initialize submodule
33+
git submodule update --init --recursive
34+
35+
# 3. Build the library, CLI, and test binaries
3336
cmake -B build -DCMAKE_BUILD_TYPE=Release \
3437
-DFLAGFFT_BUILD_CLI=ON \
3538
-DFLAGFFT_BUILD_TESTS=ON
3639
cmake --build build -j$(nproc)
3740

38-
# 3. Install the Python codegen package (required for JIT kernel generation)
41+
# 4. Install the Python codegen package (required for JIT kernel generation)
3942
pip install .
4043

41-
# 4. Run the full accuracy + performance test suite
44+
# 5. Run the full accuracy + performance test suite
4245
python tools/run_tests.py --combination full --gpus 0
4346
```
4447

@@ -53,7 +56,7 @@ A pre-built environment with all dependencies is available:
5356
```bash
5457
docker build -t flagfft-dev -f docker/Dockerfile .
5558
docker run --gpus all -v $(pwd):/workspace/FlagFFT-dev -it flagfft-dev
56-
# Inside the container, run steps 2-4 from above.
59+
# Inside the container, run steps 3-5 from above.
5760
```
5861

5962
---

0 commit comments

Comments
 (0)