-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
23 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,31 @@ | ||
# Romanizer | ||
|
||
Provides a number converter for translating between regular integers and their equivalent extended roman numerals. | ||
Provides a number converter for translating between regular integers and their equivalent extended roman numerals representation. | ||
|
||
# How To Use | ||
|
||
TODO: | ||
Converting to roman numerals: | ||
``` | ||
String result = Romanizer.romanize(5); // --> "IV" | ||
``` | ||
|
||
Converting from roman numerals: | ||
``` | ||
int number = Romanizer.deromanize("IV"); // --> 5 | ||
``` | ||
|
||
# Adding to your project | ||
|
||
TODO: | ||
You can download the jar and sources from the [releases tab](https://github.com/Sollace/Romanizer/releases) | ||
|
||
Add it to a folder in your gradle project named "lib" and then specify it as a dependency like so: | ||
|
||
``` | ||
repositories { | ||
flatDir { dirs 'lib' } | ||
} | ||
... | ||
dependencies { | ||
compileOnly "com.sollace:Romanizer:Romanizer:1.0.2" | ||
} | ||
``` |