From dff329da7fa90e8c15b40aff0ea5d4d710ff8ed7 Mon Sep 17 00:00:00 2001
From: mik-p <mppritchard3@hotmail.com>
Date: Thu, 31 Oct 2024 12:24:17 +1100
Subject: [PATCH] add dev deps, add to readme

---
 README.md            | 19 ++++++++++++++++++-
 requirements-dev.txt |  1 +
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f8969b4..64dba21 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,8 @@
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/MPO-Web-Consulting/ros-notebook/HEAD)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
 [![Open in Visual Studio Code](https://img.shields.io/badge/vscode-dev-blue)](https://open.vscode.dev/MPO-Web-Consulting/ros-notebook)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/mpo-web-consulting/ros-notebook/datascience-humble.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f5e4c6bc6a9d0d407b4b/maintainability)](https://codeclimate.com/github/MPO-Web-Consulting/ros-notebook/maintainability)
 
 ros-notebook is a community maintained [Jupyter Docker Stack](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/stacks.html) image that adds [ROS](https://www.ros.org/) to the common notebook containers such as the `datascience-notebook`.
 
@@ -52,7 +54,22 @@ RUN mamba install -y tensorflow && \
 USER ${NB_UID}
 ```
 
-## Generate Images and Actions
+## Development
+
+### install dependencies
+
+```bash
+# create a virtual environment
+python3 -m venv venv
+
+# activate the virtual environment
+source venv/bin/activate
+
+# install the dependencies
+pip install -r requirements-dev.txt
+```
+
+### Generate Images and Actions
 
 The images and actions are generated from templates using [Jinja2](https://jinja.palletsprojects.com/en/3.0.x/). The templates are located in the `templates` directory. The images are defined in `images.yaml`.
 
diff --git a/requirements-dev.txt b/requirements-dev.txt
index 8ec2245..61e6323 100644
--- a/requirements-dev.txt
+++ b/requirements-dev.txt
@@ -2,3 +2,4 @@ docker
 pytest
 requests
 jinja2
+pyyaml