Merge pull request #12 from ins-amu/develop

Develop

.github/workflows/docker-image.yml

@@ -2,8 +2,8 @@ name: build & push Docker image to ghcr
 
 on:
   push:
-    branches:
-      - main  # Runs when pushing to develop branch
+    # branches:
+    #   - main  # Runs when pushing to develop branch
     tags:
       - v*  # Runs when pushing tags starting with 'v'
 

README.md

@@ -1,8 +1,7 @@
 [![Test](https://github.com/ins-amu/vbi/actions/workflows/tests.yml/badge.svg)](https://github.com/ins-amu/vbi/actions/workflows/tests.yml)
 [![Documentation Status](https://readthedocs.org/projects/vbi/badge/?version=latest)](https://vbi.readthedocs.io/latest/)
 [![DOI](https://zenodo.org/badge/681090816.svg)](https://doi.org/10.5281/zenodo.14795543)
-
-
+[![Docker Build](https://github.com/ins-amu/vbi/actions/workflows/docker-image.yml/badge.svg)](https://github.com/ins-amu/vbi/actions/workflows/docker-image.yml)
 
 # Virtual Brain Inference (VBI)
 <p align="center">
@@ -27,10 +26,19 @@
 To use the Docker image, you can pull it from the GitHub Container Registry and run it as follows:
 
 ```bash
+    # Get it without building anything locally
+    # without GPU
+    docker run --rm -it ghcr.io/ins-amu/vbi:main
+
+    # with GPU
+    docker run --gpus all --rm -it ghcr.io/ins-amu/vbi:main
+
+
+    # or build it locally:
     docker build -t vbi-project .         # build
     docker run --gpus all -it vbi-project # use with gpu
 
-    # Output something like this:
+    # Output is expected to be something like this:
 
                 Dependency Check