Skip to content

Update README instructions for cloning and building #4679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README instructions for cloning and building #4679

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]: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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I frankly don't even know this is needed. I never had an issue cloning (on ubuntu) and I others on the team on Mac don't have this large file support installed. Can you tell us what happens? I'd like to not have this dependency to clone of course ,but there seems to be a deeper issue here.

Thanks!

- Optionally ignore the large files to reduce disk size (won't affect the spring-ai behaviour): `GIT_LFS_SKIP_SMUDGE=1 git clone [email protected]: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

Expand Down