Skip to content

Commit 59c9c1b

Browse files
authored
Clarify in the README which git lfs files are required to build GATK (#8914)
Resolves #8912
1 parent b97448c commit 59c9c1b

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,9 @@ For more details on system packages, see the GATK [Base Dockerfile](scripts/dock
156156
157157
* This creates a zip archive in the `build/` directory with a name like `gatk-VERSION.zip` containing a complete standalone GATK distribution, including our launcher `gatk`, both the local and spark jars, and this README.
158158
* You can also run GATK commands directly from the root of your git clone after running this command.
159-
* Note that you *must* have a full git clone in order to build GATK, including the git-lfs files in src/main/resources. The zipped source code alone is not buildable.
159+
* Note that you *must* have a full git clone in order to build GATK, including the git-lfs files in `src/main/resources/large`. The zipped source code alone is not buildable.
160+
* The large files under `src/main/resources/large/` are required to build GATK, since they are packaged inside the GATK jar and used by tools at runtime. These include things like ML models and native C/C++ libraries used for acceleration of certain tools.
161+
* The large files under `src/test/resources/large/`, on the other hand, are only required by the test suite when running tests, and are not required to build GATK.
160162

161163
* **Other ways to build:**
162164
* `./gradlew installDist`

0 commit comments

Comments
 (0)