From fbc0bdba26cc023ae7177f2f03312bdc56dd92de Mon Sep 17 00:00:00 2001 From: Robert McNees <86265089+robertmcnees@users.noreply.github.com> Date: Mon, 20 Oct 2025 08:26:28 -0400 Subject: [PATCH] Update README instructions for cloning and building Git Large File Storage is required to clone the project. To build the project a container runtime (i.e. Docker Desktop) is required to be running locally. Signed-off-by: Robert McNees <86265089+robertmcnees@users.noreply.github.com> --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 54924b12a13..f93ada0201d 100644 --- a/README.md +++ b/README.md @@ -57,15 +57,15 @@ Please refer to the [Getting Started Guide](https://docs.spring.io/spring-ai/ref ## Cloning the repo This repository contains [large model files](https://github.com/spring-projects/spring-ai/tree/main/models/spring-ai-transformers/src/main/resources/onnx/all-MiniLM-L6-v2). -To clone it you have to either: +To clone it you have to: -- Ignore the large files (won't affect the spring-ai behaviour) : `GIT_LFS_SKIP_SMUDGE=1 git clone git@github.com:spring-projects/spring-ai.git`. -- Or install the [Git Large File Storage](https://git-lfs.com/) before cloning the repo. +- Install the [Git Large File Storage](https://git-lfs.com/) before cloning the repo. +- Optionally ignore the large files to reduce disk size (won't affect the spring-ai behaviour): `GIT_LFS_SKIP_SMUDGE=1 git clone git@github.com:spring-projects/spring-ai.git`. ## Building -Build using Java 17. +Build using Java 17. A container runtime is required. To build with running unit tests