diff --git a/README.md b/README.md index 726486e..3c03d68 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,23 @@ JupyterHub Batch Spawner for GLiCID =================================== -Setup ------ +![Spawner form](img/spawner_form.png) + + +JupyterHub config +----------------- + +In `jupyterhub_config.py`, add: +```txt +c.JupyterHub.spawner_class = 'glicid-spawner' +``` + +At the moment, you also need to change the `c.GlicidSpawner.batch_script`. +This will be be included in the future. + + +Contribution +------------ This package is managed by [Poetry](https://python-poetry.org/): ```bash git clone https://gitlab.univ-nantes.fr/glicid/jupyter/spawner glicid-spawner @@ -32,18 +47,6 @@ To activate the virtual environement globally: source .venv/bin/activate ``` -JupyterHub config ------------------ - -In `jupyterhub_config.py`, add: -```txt -c.JupyterHub.spawner_class = 'glicid-spawner' -``` - -At the moment, you also need to change the `c.GlicidSpawner.batch_script`. -This will be be included in the future. - - External resources ------------------ - https://jupyterhub.readthedocs.io/en/stable/reference/spawners.html diff --git a/img/spawner_form.png b/img/spawner_form.png new file mode 100644 index 0000000..301fcde Binary files /dev/null and b/img/spawner_form.png differ