diff --git a/README.md b/README.md index c3cc013..6bbc36c 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,10 @@ isn't required.` git clone https://git.psi.ch/lsm-hpce/merlin-cryosparc.git config Next, all `cluster_info.json` scripts need to be modified to include the correct -worker path by replacing `USERNAME`. +worker path by replacing `USERNAME`. A script is provided to do this +automatically: + + dev/install_filters.sh Finally, connect the newly modified scripts to cryosparc. This should be done on same machine cryosparc runs on. To connect all lanes: @@ -41,6 +44,14 @@ Then, connect the lanes to your cryosparc cluster as in installation: ./connect_all.sh +## Developers + +If you plan on committing changes to this repository, make sure you run +`dev/install_filters.sh` to install git hooks and filters. + +When releasing a new version, `dev/mkrelease.sh` will update version numbers +consistently. + ## References - [PSI CryoSparc docs](https://intranet.psi.ch/BIO/ComputingCryoSPARC) diff --git a/dev/install_filters.sh b/dev/install_filters.sh index 3d78ae1..03fda8e 100755 --- a/dev/install_filters.sh +++ b/dev/install_filters.sh @@ -9,6 +9,9 @@ cd "$ROOT" git config filter.username.smudge dev/git-filter-smudge-username.sh git config filter.username.clean dev/git-filter-clean-username.sh +# Initial smudge +sed -i -e "s/USERNAME/$USER/g" */cluster_info.json + # pre-commit hook to varify usernames aren't committed if [ -f .git/hooks/pre-commit ]; then if ! cmp -s .git/hooks/pre-commit dev/pre-commit; then