From beab40d64c53172d0476007e2966289fd6a2ec9f Mon Sep 17 00:00:00 2001
From: Emmanuel Bruno <emmanuel.bruno@univ-tln.fr>
Date: Wed, 29 Mar 2023 18:22:27 +0200
Subject: [PATCH] adds a basic README

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2ef7b73
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# JupyterLab Base Image
+
+**Test it on** [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ebpro/notebook-qs-base/develop)
+
+A base image for the Jupyter Lab ased on jupyter/minimal-notebook :
+  
+* ZSH
+* TexLive
+* Code Server Web IDE
+* Jupyter Book
+
+## Quickstart
+
+```bash
+docker run --rm --name jupyter-base-${PWD##*/} \
+  --volume data-${PWD##*/}:/home/jovyan/work/${PWD##*/} \
+  --publish 8888:8888 \
+  --env NB_UID=$UID \
+  brunoe/jupyter-base:develop start-notebook.sh --notebook-dir=work/${PWD##*/}
+```
+
+## Host files and UIDs
+
+```bash
+docker run --rm --name jupyter-base-${PWD##*/} \
+  --user root
+  --volume $PWD:/home/jovyan/work/${PWD##*/} \
+  --volume /var/run/docker.sock:/var/run/docker.sock \
+  --publish 8888:8888 \
+  --env NB_UID=$UID \
+  brunoe/jupyter-base:develop start-notebook.sh --notebook-dir=work/${PWD##*/}
+```
+
+## With Docker support
+
+```bash
+docker run --rm --name jupyter-base-${PWD##*/} \
+  --user root \
+  --privileged=true \
+  --volume $PWD:/home/jovyan/work/${PWD##*/} \
+  --volume /var/run/docker.sock:/var/run/docker.sock \
+  --publish 8888:8888 \
+  --env NB_UID=$UID \
+  brunoe/jupyter-base:develop start-notebook.sh --notebook-dir=work/${PWD##*/}
+```
-- 
GitLab