From 1e53de56ef0df6d94ae995297979720c6f493b13 Mon Sep 17 00:00:00 2001 From: Matthew Evans <7916000+ml-evs@users.noreply.github.com> Date: Fri, 12 Jul 2024 14:33:53 +0100 Subject: [PATCH] LFS note formatting and location in README --- README.md | 37 ++++++++++++++++++------------------- 1 file changed, 18 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 4b7e7de..b28b9b6 100644 --- a/README.md +++ b/README.md @@ -9,23 +9,6 @@ SPDX-License-Identifier: GPL-3.0-or-later Read proprietary file formats from electrochemical test stations. -> [!WARNING] -> A note about test files and Git LFS: -> -> 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://github.com/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. - # Usage ## Bio-Logic .mpr files @@ -64,14 +47,30 @@ 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: +The latest development version can be installed with `pip` directly from GitHub (see note about git-lfs below): ```shell -pip install git+https://github.com/echemdata/galvani +GIT_LFS_SKIP_SMUDGE=1 pip install git+https://github.com/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://github.com/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