Skip to content

Commit

Permalink
chore: add lfs install and pull in project_setup
Browse files Browse the repository at this point in the history
  • Loading branch information
RomanBredehoft committed Apr 15, 2024
1 parent 72e5797 commit 3e65c1f
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/developer/project_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,15 @@ rm -rf concrete-ml
git clone https://github.com/zama-ai/concrete-ml
```

Several files are tracked by [git-lfs](https://git-lfs.github.com/). While a few are required for running some tests, most of them are used for benchmarking and use case examples. By default, `git clone` downloads all LFS files, which can add up to several hundreds of MB to the directory. Is it however possible to disable such behavior by running the running the following command instead :
In order to be able to run all documentation examples, we recommend to also [install git-lfs](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage) and then pull the necessary files :

<!--pytest-codeblocks:skip-->

```bash
git lfs pull
```

On the contrary, to disable downloading all these files (which represents up to several hundreds of MB) when cloning the repository, simply run :

<!--pytest-codeblocks:skip-->

Expand Down

0 comments on commit 3e65c1f

Please sign in to comment.