Skip to content

Commit

Permalink
README.md contains ruby installtion guides
Browse files Browse the repository at this point in the history
  • Loading branch information
blacksmith-welder committed Sep 17, 2024
1 parent dbd7a38 commit 8c20529
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 8c20529

Please sign in to comment.