From 8c2052907c823801e4ab5d282d150be886c08cc5 Mon Sep 17 00:00:00 2001
From: blacksmith-welder <delasthanosdev@gmail.com>
Date: Tue, 17 Sep 2024 19:28:45 +0300
Subject: [PATCH] README.md contains ruby installtion guides

---
 README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 59f8de64..c06f4a95 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,38 @@
 ## Archives Space End-to-End Tests
 
+### Setup
+
+#### Install Ruby
+
+The currently required Ruby version is in the root folder inside the [.ruby-version](https://github.com/archivesspace/e2e-tests/blob/master/.ruby-version) file.
+
+It is strongly recommended to use a Ruby version manager to be able to switch to any version.
+The most popular version manager available for `Linux` and `macOS`, is `rbenv`.
+You can find the installation guide here [https://github.com/rbenv/rbenv#readme](https://github.com/rbenv/rbenv#readme).
+If you are on `Windows`, a separate `rbenv` installer exists here: [https://github.com/RubyMetric/rbenv-for-windows#readme](https://github.com/RubyMetric/rbenv-for-windows#readme).
+If you wish to use a different manager or installation method, you can choose one of the following: [https://www.ruby-lang.org/en/documentation/installation/](https://www.ruby-lang.org/en/documentation/installation/)
+
+
 #### How to install
 
 Clone this repository on your machine, navigate to the root application folder, and run:
 
+
+```sh
+rbenv install
+```
+
+```sh
+gem install bundler
 ```
+
+```sh
 bundle install
 ```
 
 ### How to run the tests
 
-#### Run on remote host
+#### Run on the remote host
 To run the tests on the `https://e2e.archivesspace.org`, run:
 ```
 bundle exec cucumber