Skip to content

Commit 03dbfcc

Browse files
committed
Update README with usage example
1 parent 656324b commit 03dbfcc

File tree

1 file changed

+43
-4
lines changed

1 file changed

+43
-4
lines changed

README.adoc

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,53 @@ These transliteration systems currently work:
2424

2525
== Usage
2626

27+
Assume you have a file ready in the source script like this:
2728

2829
[source,sh]
2930
----
30-
# Transliterating Russian Cyrillic to Latin using the Streamlined System for Russian
31-
interscript samples/rus-Cyrl.txt --system=bas-rus-Cyrl-Latn-bss --output=rus-Latn.txt
31+
cat <<EOT > rus-Cyrl.txt
32+
Эх, тройка! птица тройка, кто тебя выдумал? знать, у бойкого народа ты
33+
могла только родиться, в той земле, что не любит шутить, а
34+
ровнем-гладнем разметнулась на полсвета, да и ступай считать версты,
35+
пока не зарябит тебе в очи. И не хитрый, кажись, дорожный снаряд, не
36+
железным схвачен винтом, а наскоро живьём с одним топором да долотом
37+
снарядил и собрал тебя ярославский расторопный мужик. Не в немецких
38+
ботфортах ямщик: борода да рукавицы, и сидит чёрт знает на чём; а
39+
привстал, да замахнулся, да затянул песню — кони вихрем, спицы в
40+
колесах смешались в один гладкий круг, только дрогнула дорога, да
41+
вскрикнул в испуге остановившийся пешеход — и вон она понеслась,
42+
понеслась, понеслась!
43+
44+
Н.В. Гоголь
45+
EOT
46+
----
47+
48+
You can run `interscript` on this text using different transliteration systems.
49+
50+
[source,sh]
51+
----
52+
interscript rus-Cyrl.txt \
53+
--system=bgnpcgn-rus-Cyrl-Latn-1947 \
54+
--output=bgnpcgn-rus-Latn.txt
55+
56+
interscript rus-Cyrl.txt \
57+
--system=iso-rus-Cyrl-Latn-iso9 \
58+
--output=iso-rus-Latn.txt
3259
33-
# Transliterating Russian Cyrillic to Latin using the BGN/PCGN Romanization of Russian
34-
interscript samples/rus-Cyrl.txt --system=bgnpcgn-rus-Cyrl-Latn-1947 --output=rus-Latn.txt
60+
interscript rus-Cyrl.txt \
61+
--system=icao-rus-Cyrl-Latn-9303 \
62+
--output=icao-rus-Latn.txt
63+
64+
interscript rus-Cyrl.txt \
65+
--system=bas-rus-Cyrl-Latn-bss \
66+
--output=bas-rus-Latn.txt
67+
----
68+
69+
It is then easy to see the exact differences in rendering between the systems.
70+
71+
[source,sh]
72+
----
73+
diff bgnpcgn-rus-Latn.txt bas-rus-Latn.txt
3574
----
3675

3776

0 commit comments

Comments
 (0)