From 9fc4b5e3fd5ac6d379f83fb01d79f296ec99f182 Mon Sep 17 00:00:00 2001
From: James Jefferies <james@shedcode.co.uk>
Date: Fri, 20 Dec 2024 10:59:24 +0000
Subject: [PATCH] Update documentation for Ruby 3.3.6

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 46 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 357ca75..6e60fc7 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,53 @@
-# README
+# Written question and answer bots
+
+## Intro
+
+An application which posts to Mastodon and Bluesky, importing questions, written statements etc from data APIs.
+
+## Technical
 
 This app uses Ruby on Rails, dependency management via bundler.
 
-Ruby version management can use `rvm` or `asdf` out of the box.
+Ruby version management can use `rvm` or `asdf` out of the box. Note that if installing ruby versions (3.3.6 for example) on macOS, you may need to add the open ssl directory manually.
+
+### Ruby install using rvm
+
+Usually you can install new ruby versions with 
+
+```
+rvm install 3.3.6
+```
+
+However this can fail on some macOS installations. To remedy this:
+
+Make sure open ssl v3 is installed using `brew`
+
+```
+brew install openssl@3
+```
+
+and then get the installation path where this is installed.
+
+```
+brew --prefix openssl@3
+```
+
+and finally try installing rvm like this
+
+```
+rvm install 3.3.6 --with-openssl-dir=[Put the openssl install dir here]
+```
+
+You might be able to get away with this if running `bash`
+
+```
+rvm install 3.2.2 --with-openssl-dir=$(brew --prefix openssl@3)
+```
+
+### Javascript
 
 There is no javascript pipeline
 
+### Github actions
+
 GitHub actions should be enabled