From 3d1706be6d9a49d984b71b3d394ed22e589cb697 Mon Sep 17 00:00:00 2001 From: emily Date: Fri, 3 Nov 2023 15:51:31 +0100 Subject: [PATCH] improve Ruby docs --- ruby/README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 ruby/README.md diff --git a/ruby/README.md b/ruby/README.md new file mode 100644 index 00000000..731dfcaa --- /dev/null +++ b/ruby/README.md @@ -0,0 +1,31 @@ +# Gilded Rose starting position in Ruby + +## Installation + + +## Run the unit tests from the Command-Line + +Ensure you have RSpec installed + + gem install rspec + +``` +ruby gilded_rose_spec.rb +``` + +## Run the TextTest fixture from the Command-Line + +For e.g. 10 days: + +``` +ruby texttest_fixture.rb 10 +``` + +You should make sure the command shown above works when you execute it in a terminal before trying to use TextTest (see below). + +## Run the TextTest approval test that comes with this project + +There are instructions in the [TextTest Readme](../texttests/README.md) for setting up TextTest. You will need to specify the Ruby executable and interpreter in [config.gr](../texttests/config.gr). Uncomment these lines: + + executable:${TEXTTEST_HOME}/ruby/texttest_fixture.rb + interpreter:ruby