Browse Source

Merge branch 'master' into index

Lennart Wittkuhn 1 year ago
parent
commit
67b800c605
1 changed files with 18 additions and 1 deletions
  1. 18 1
      README.md

+ 18 - 1
README.md

@@ -1,5 +1,6 @@
 # Replay Illustrations
 
+[![License: CC BY 4.0](https://img.shields.io/badge/License-CC_BY_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
 [![made-with-datalad](https://www.datalad.org/badges/made_with.svg)](https://datalad.org)
 
 ## About
@@ -30,7 +31,7 @@ At this point, it contains only small metadata and information on the identity o
 After cloning a dataset, you can retrieve file contents by running
 
 ```bash
-datalad get <path/to/directory/or/file>`
+datalad get <path/to/directory/or/file>
 ```
 
 This command will trigger a download of the files, directories, or subdatasets you have specified.
@@ -71,6 +72,22 @@ To edit the `.afdesign` files you need [Affinity Designer](https://affinity.seri
 I currently use version 1.5.5.
 Affinity Designer is not free but cheaper than Adobe Illustrator.
 
+### DataLad
+
+#### DataLad Docker
+
+After updating the [Dockerfile](.docker/datalad/Dockerfile), I use the following command to build and push the newest image to [dockerhub](https://hub.docker.com/r/lennartwittkuhn/datalad) (following `docker login`):
+
+```bash
+export DATALAD_VERSION=0.17.6
+docker build -t lennartwittkuhn/datalad:$DATALAD_VERSION --platform linux/arm64 --build-arg DOCKER_TAG=$DATALAD_VERSION .docker/datalad
+docker push lennartwittkuhn/datalad:$DATALAD_VERSION
+```
+
+```bash
+docker run --rm  --entrypoint /bin/sh --platform linux/arm64 --memory="100M" lennartwittkuhn/datalad:$DATALAD_VERSION -c "datalad install --get-data https://github.com/lnnrtwttkhn/replay-illustrations"
+```
+
 ## Credit
 
 Several illustrations contain images from [BioRender.com](https://biorender.com/) which were created under a plan for the [Max Planck Society](https://www.mpg.de/en) which allows publication in journals and for other academic purposes (for details, see BioRender's [overview of Licensing and Usage](https://public.biorender.com/info/plans.pdf)).