From 4ae6c1667705056cd885f2f9cb75b3e641408736 Mon Sep 17 00:00:00 2001
From: David Cliff <dgcliff@northeastern.edu>
Date: Wed, 15 Jan 2025 18:35:21 +0000
Subject: [PATCH] Update readme for basic dev install instructions, add yaml
 package for psych gem

---
 .version   |  2 +-
 Dockerfile |  2 +-
 README.md  | 24 ++++++++++++++++++++++++
 3 files changed, 26 insertions(+), 2 deletions(-)

diff --git a/.version b/.version
index 4067d1db7..38bc52136 100644
--- a/.version
+++ b/.version
@@ -1 +1 @@
-2.8.10
+2.8.11
diff --git a/Dockerfile b/Dockerfile
index 370a76551..b27e2e0ee 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -2,7 +2,7 @@ FROM ruby:3.2-slim
 # update the repository sources list
 # and install dependencies
 RUN apt-get update \
-    && apt-get install -y nodejs curl git build-essential libpq-dev libmagic-dev libvips-dev \
+    && apt-get install -y nodejs curl git build-essential libpq-dev libmagic-dev libvips-dev libyaml-dev \
     && apt-get -y autoclean
 
 RUN curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > /usr/local/bin/cc-test-reporter
diff --git a/README.md b/README.md
index 3c2a78cf2..e4a898c19 100644
--- a/README.md
+++ b/README.md
@@ -5,3 +5,27 @@
 Cerberus is the Ruby on Rails codebase for Northeastern's Digital Repository Service.
 
 The code base utilizes Valkyrie, Blacklight, Solr and PostgreSQL
+
+## Getting started
+
+Make sure you have docker installed.
+
+Get a copy of the codebase
+```
+git clone git@github.com:NEU-Libraries/cerberus.git
+```
+
+Use docker compose to pull down the containers and build Cerberus
+```
+ATLAS=0.0.157 docker compose -f docker-compose.yml -f docker-compose.dev.yml up --build
+```
+
+Once running, use another console/tab to go inside the container.
+```
+docker exec -ti cerberus-web-1 /bin/sh
+```
+
+Once inside, generate some test objects
+```
+bundle exec rake reset:data
+```
\ No newline at end of file