Skip to content

Commit

Permalink
Readme changes
Browse files Browse the repository at this point in the history
  • Loading branch information
sathish316 committed Aug 28, 2011
1 parent a18c125 commit b74c934
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions README.markdwon → README
@@ -1,12 +1,12 @@
= Ruby Metaprogramming Koans
## Ruby Metaprogramming Koans

Ruby Metaprogramming Koans walk you along the path to enlightenment in order to learn Metaprogramming in Ruby.
It is inspired by the original [Ruby koans](http://rubykoans.com) by Jim Weirich which can be forked here: https://github.com/edgecase/ruby_koans

Koans teach you a programming language using Tests/TDD.
Metaprogramming koans attempts to teach Ruby metaprogramming using the same philosophy of koans used for programming languages.

== Metaprogramming examples
### Metaprogramming examples

The metaprogramming examples used in the koans are derived from the following sources:

Expand All @@ -17,7 +17,7 @@ http://pragprog.com/screencasts/v-dtrubyom/the-ruby-object-model-and-metaprogram
The koans are a starting point and only supplement the above articles/books/videos.
Please use the original source for more enlightenment.

== The Structure
### The Structure

The koans are broken out into areas by file, metaclasses are covered in about_metaclasses.rb,
define_method is covered in about_define_method.rb, etc. They are presented in order in the
Expand All @@ -26,7 +26,7 @@ path_to_enlightenment.rb file.
Each koan builds up your knowledge of Ruby metaprogramming and builds upon itself. Koans will
have __ or ___ which you need to fill in with the correct answer to progress.

== Installing Ruby
### Installing Ruby

The koans require Ruby 1.9.2. To install Ruby:

Expand All @@ -37,7 +37,7 @@ $ rvm install ruby-1.9.2

All the koans are in Test::Unit and don't require additional gems

== The Path To Enlightenment
### The Path To Enlightenment

To start working your way through the koans, run rake

Expand All @@ -53,7 +53,7 @@ metaprogramming_koans$ ruby about_metaclasses.rb

Follow the instructions and keep filling the answers to start your journey towards mastering metaprogramming in Ruby

== Inspiration
### Inspiration

[The Little Schemer](http://www.amazon.com/Little-Schemer-Daniel-P-Friedman/dp/0262560992)
by Daniel Friedman is one of my all time favorite programming books.
Expand All @@ -68,7 +68,7 @@ it is an automated testsuite that's asking you questions.

If you're learning Ruby, you should check out the [original koans](http://github.com/edgecase/ruby_koans) first:

== Other Resources
### Other Resources

To get more insight on the Ruby koans way of learning, check out the [EdgeCase Ruby koans](http://github.com/edgecase/ruby_koans):

Expand All @@ -77,7 +77,7 @@ Following are some more resources to learn Metaprogramming in Ruby:
2. Ruby Object model and metaprogramming screencasts http://pragprog.com/screencasts/v-dtrubyom/the-ruby-object-model-and-metaprogramming
3. Metaprogramming Ruby http://pragprog.com/book/ppmetr/metaprogramming-ruby

== How do i add my own koans?
### Adding Koans

To add your own koans and contribute to the community:
1. Fork this repo
Expand All @@ -88,7 +88,5 @@ To add your own koans and contribute to the community:
6. Execute $rake gen to generate koans/about_foo.rb with all assertions replaced with __
7. Create pull request

== License

You're free to copy, add, change or distribute the koans here.
The structure of this whole project is forked from Edgecase Ruby koans (https://github.com/edgecase/ruby_koans)

0 comments on commit b74c934

Please sign in to comment.