chris/galvani
1
0
Fork 0
mirror of https://github.com/echemdata/galvani.git synced 2025-12-12 16:45:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove warning about Git LFS bandwidth limits

Browse Source
This commit is contained in:
Chris Kerr
2025-03-23 14:50:54 +02:00
parent 627387f9c4
commit 4efec58374
1 changed files with 2 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -47,30 +47,14 @@ The latest galvani releases can be installed from [PyPI](https://pypi.org/projec
pip install galvani
```
The latest development version can be installed with `pip` directly from GitHub (see note about git-lfs below):
The latest development version can be installed with `pip` directly from GitHub:
```shell
GIT_LFS_SKIP_SMUDGE=1 pip install git+https://codeberg.org/echemdata/galvani
pip install git+https://codeberg.org/echemdata/galvani
```
## Development installation and contributing
> [!WARNING]
>
> This project uses Git Large File Storage (LFS) to store its test files,
> however the LFS quota provided by GitHub is frequently exceeded.
> This means that anyone cloning the repository with LFS installed will get
> failures unless they set the `GIT_LFS_SKIP_SMUDGE=1` environment variable when
> cloning.
> The full test data from the last release can always be obtained by
> downloading the GitHub release archives (tar or zip), at
> https://codeberg.org/echemdata/galvani/releases/latest
>
> If you wish to add test files, please ensure they are as small as possible,
> and take care that your tests work locally without the need for the LFS files.
> Ideally, you could commit them to your fork when making a PR, and then they
> can be converted to LFS files as part of the review.
If you wish to contribute to galvani, please clone the repository and install the testing dependencies:
```shell