aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTeddy Wing2015-05-30 15:19:30 -0400
committerTeddy Wing2015-05-30 15:19:30 -0400
commita53d75c2634366b4a99821eb7f0918e43d9717cf (patch)
treeca4e28b9841a00aba4fd7c114e4478006b38c067 /README.md
parentb73ede2325dd9fb9bebce009d52986b0cadcf7a9 (diff)
downloadBeginning-Ruby-Exercises-master.tar.bz2
Add LICENSE & READMEHEADmaster
* MIT License * README includes a description of the project shows how to run the tests to check solutions to the exercises.
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c8bef94
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+Beginning Ruby Exercises
+========================
+
+A small set of Ruby exercises aimed at beginning programmers learning Ruby.
+Written for one of my students at [The Firehose
+Project](http://www.thefirehoseproject.com/).
+
+Write solutions to exercises in [exercises.rb](exercises.rb). My solutions are
+available in [exercises_solutions.rb](exercises_solutions.rb).
+
+
+## Checking your solutions
+Find out if your solutions are correct by running the tests. These can be run
+for individual exercises using using `run_test.sh`:
+
+ $ ./run_test.sh 3
+
+The above command will run the tests for exercise 3.
+
+After completing the exercises, all the tests can be run using the spec file
+directly:
+
+ $ ruby exercises_spec.rb
+
+
+## License
+Licensed under the MIT License. See the included LICENSE file.