Update README instructions for cloning and building

[robertmcnees]

Minor changes to the README to include two small tasks to get the code to clone and compile locally.

git-lfs is required
Git Large File Storage is required to clone the project. Even with the command GIT_LFS_SKIP_SMUDGE=1 I still got the error:

git-lfs filter-process: git-lfs: command not found
fatal: the remote end hung up unexpectedly
warning: Clone succeeded, but checkout failed.

After a brew install git-lfs things worked fine. I verified after that the GIT_LFS_SKIP_SMUDGE=1 did reduce the disk size of the download. But git-lfs seems to be a requirement.

Run Docker Desktop
To build the project I needed a container runtime (i.e. Docker Desktop) running locally.

[markpollack]

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!

[robertmcnees]

Maybe it's local to my machine. I pasted my experience below in detail. It's a small change so if it's not true for everyone feel free to close the PR.

[robertmcnees]

Additional context on my experience cloning the repository. I was using https, not ssh.

No git-lfs
No GIT_LFS_SKIP_SMUDGE

mcnees@mac temp % git clone https://github.com/spring-projects/spring-ai.git
Cloning into 'spring-ai'...
remote: Enumerating objects: 116717, done.
remote: Counting objects: 100% (360/360), done.
remote: Compressing objects: 100% (237/237), done.
remote: Total 116717 (delta 178), reused 137 (delta 107), pack-reused 116357 (from 3)
Receiving objects: 100% (116717/116717), 87.17 MiB | 34.32 MiB/s, done.
Resolving deltas: 100% (45643/45643), done.
git-lfs filter-process: git-lfs: command not found
fatal: the remote end hung up unexpectedly
warning: Clone succeeded, but checkout failed.
You can inspect what was checked out with 'git status'
and retry with 'git restore --source=HEAD :/'

No git-lfs
With GIT_LFS_SKIP_SMUDGE

mcnees@mac temp % GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/spring-projects/spring-ai.git
Cloning into 'spring-ai'...
remote: Enumerating objects: 116717, done.
remote: Counting objects: 100% (361/361), done.
remote: Compressing objects: 100% (244/244), done.
remote: Total 116717 (delta 177), reused 131 (delta 101), pack-reused 116356 (from 3)
Receiving objects: 100% (116717/116717), 87.17 MiB | 22.81 MiB/s, done.
Resolving deltas: 100% (45687/45687), done.
git-lfs filter-process: git-lfs: command not found
fatal: the remote end hung up unexpectedly
warning: Clone succeeded, but checkout failed.
You can inspect what was checked out with 'git status'
and retry with 'git restore --source=HEAD :/'

In both cases the folder only checked out a subset of files:

In both instances, this error message seems relevant:
git-lfs filter-process: git-lfs: command not found

Could that be because of .gitattributes?

Once I installed git-lfs things were smooth.

With git-lfs
No GIT_LFS_SKIP_SMUDGE

mcnees@mac temp % brew install git-lfs

mcnees@mac temp % git clone https://github.com/spring-projects/spring-ai.git
Cloning into 'spring-ai'...
remote: Enumerating objects: 116717, done.
remote: Counting objects: 100% (361/361), done.
remote: Compressing objects: 100% (244/244), done.
remote: Total 116717 (delta 177), reused 131 (delta 101), pack-reused 116356 (from 3)
Receiving objects: 100% (116717/116717), 87.17 MiB | 28.18 MiB/s, done.
Resolving deltas: 100% (45687/45687), done.