Romain/Arabic numeral conversions
Find a file
2013-09-08 10:23:41 +07:00
lib remove #roman? because it doesn't work sometimes and I don't care for it 2013-09-08 10:18:43 +07:00
spec remove #roman? because it doesn't work sometimes and I don't care for it 2013-09-08 10:18:43 +07:00
.gitignore ignore 2011-05-02 14:29:07 +01:00
Gemfile move to using bundler 2013-07-29 11:20:38 +01:00
Gemfile.lock move to using bundler 2013-07-29 11:20:38 +01:00
LICENSE.txt Initial commit to roman-numerals. 2011-05-02 14:06:42 +01:00
Rakefile move to using bundler 2013-07-29 11:20:38 +01:00
README.rdoc remove docs for #roman? 2013-09-08 10:23:41 +07:00
roman-numerals.gemspec move to using bundler 2013-07-29 11:20:38 +01:00

= roman-numerals

== Usage
In order to use the roman numerals gem, you need to add "roman-numerals" to your Gemfile
    gem 'roman-numerals'

=== Converting to a roman numeral
In order to convert a number to a roman numeral, call the to_roman method:
    RomanNumerals.to_roman(1)

=== Converting to a decimal
In order to convert to a decimal from a roman numeral, call the to_decimal method
    RomanNumerals.to_decimal('I')
    RomanNumerals.to_decimal('IIII')      # => ArgumentError

== Contributing to roman-numerals
 
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

== Copyright

Copyright (c) 2011 Andrew Vos. See LICENSE.txt for
further details.