Skip to content

Commit

Permalink
Improve formatting of README
Browse files Browse the repository at this point in the history
  • Loading branch information
thammegowda authored Jun 27, 2018
1 parent b99f9ea commit dd183fa
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions README.txt → README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,25 @@
uroman version 1.2
Release date: April 11, 2017
Author: Ulf Hermjakob, USC Information Sciences Institute
# URoman

uroman is a universal romanizer. It converts text in any script to the Latin alphabet.
*uroman* is a *universal romanizer*. It converts text in any script to the Latin alphabet.

Usage: uroman.pl [-l <lang-code>] [--chart] [--no-cache] < STDIN
Version: 1.2
Release date: April 11, 2017
Author: Ulf Hermjakob, USC Information Sciences Institute


### Usage:
```bash
$ uroman.pl [-l <lang-code>] [--chart] [--no-cache] < STDIN
where the optional <lang-code> is a 3-letter languages code, e.g. ara, fas, heb, tur, uig, ukr, yid.
--chart specifies chart output (in JSON format) to represent alternative romanizations.
--no-cache disables caching.
Examples: bin/uroman.pl < text/zho.txt
bin/uroman.pl -l tur < text/tur.txt
bin/uroman.pl -l heb --chart < text/heb.txt
```
### Examples:
```bash
$ bin/uroman.pl < text/zho.txt
$ bin/uroman.pl -l tur < text/tur.txt
$ bin/uroman.pl -l heb --chart < text/heb.txt
```

Identifying the input as Arabic, Farsi, Hebrew, Turkish, Ukrainian, Uyghur or
Yiddish will improve romanization for those languages as some letters in those
Expand Down

0 comments on commit dd183fa

Please sign in to comment.