Switch docs to RST file format.
authorOleksandr Gavenko <gavenkoa@gmail.com>
Fri, 02 Sep 2011 00:29:50 +0300
changeset 38 5f63725f1397
parent 37 e287a9f2ecf4
child 39 3fba348da719
Switch docs to RST file format.
README
README.rst
--- a/README	Fri Sep 02 00:29:07 2011 +0300
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,120 +0,0 @@
--*- outline -*-
-
-* How install/uninstall?
-
-To install in /usr/local/ run:
-
-  $ make install
-
-If you want install in different place run:
-
-  $ make install prefix=PREFIX
-
-If you install in nonstandard place and wont use dictionary for current user
-run:
-
-  $ make prefix=PREFIX install install-local-symlink
-
-To uninstall run one command from list accordingly to installation procedure:
-
-  $ make uninstall
-  $ make uninstall prefix=PREFIX
-  $ make prefix=PREFIX uninstall uninstall-local-symlink
-
-* What file needed to create dictionary?
-
-.tab_ and .descr, which contain text data in UTF-8 encoding.
-install
-
-In .tab_ file lines which begin with '#' used as comment; space after '\n'
-(two chars) removed.
-
-Words before first TAB character in .tab_ file supposed as translated word,
-rest text after TAB is word article.
-
-** .tab_ file format.
-
-Used such format:
-
-  WORD [TAB] TRANSLATION [LF]
-
-When processing TRANSLATION string in all occurrence of "\n " (literary
-back-slash small-letter-n and space) removed space.
-
-** .descr file format.
-
-First line added to .ifo file as value of description.
-
-Next lines ignored and used for miscellaneous notes.
-
-* IPA chars.
-
-Hare list of spetial IPA chars (code present in UTF-8 encoding):
-
-  θʃŋʧðʒæıʌʊɒɛəɑɜɔˌˈːˑṃṇḷ
-  æɑɒʌәєŋvθðʃʒɚːɡˏˊˋ
-
-You can copy/paste they in phonetic string.
-
-** TODO
-
-            Front       Central     Back
-         long  short long  short long  short
-  Close   iː    ɪ                 uː    ʊ
-  Mid           e     ɜː    ə     ɔː
-  Open          æ           ʌ     ɑː    ɒ
-
-      Diphthong          Triphthong
-  Closing    Centring
-   /eɪ/       /ɪə/        /aɪə/
-   /aɪ/       /eə/        /ɑʊə/
-   /ɔɪ/       /ʊə/
-   /əʊ/
-   /aʊ/
-
-** Old vs. new transcription.
-
-From "Better English pronunciation.":
-
-  Old  iː i e ɔː u uː ei ou ai au ɔi æ ɔ ʌ əː ɑː iə ɛə uə ə
-  New  iː ɪ e ɔː ʊ uː eɪ əʊ aɪ aʊ ɔɪ æ ɒ ʌ ɜː ɑː ɪə eə ʊə ə
-
-Also from wikipedia:
-
-  Old  æ e əː ʌɪ ɑʊ ɛə
-  New  a ɛ ɜː aɪ aʊ eə
-
-** Emacs.
-
-For entering IPA chars use IPA input method. To enable it type
-
-  C-u C-\ ipa <enter>
-
-All chars from alphabet typed as usual. How type special chars see below:
-
-For vowel:
-
-  æ ae
-  ɑ o| (small letter o and ) or A (upper letter A)
-  ɒ |o () or /A
-  ʊ U (upper-letter-u)
-  ɛ /3 (slash three)
-  ɔ /c
-  ə /e
-  ʌ /v
-  ɪ I
-
-For consonant:
-
-  θ th
-  ð dh
-  ʃ sh
-  ʒ zh or 3
-  ŋ ng
-
-Special chars:
-
-  ː : (semicolon)
-  ˈ ' (quote)
-  ˌ ` (back quote)
-
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst	Fri Sep 02 00:29:50 2011 +0300
@@ -0,0 +1,133 @@
+
+==========================
+ gadict dictionaries set.
+==========================
+.. contents::
+
+How install/uninstall?
+======================
+
+To install in /usr/local/ run::
+
+  $ make install
+
+If you want install in different place run::
+
+  $ make install prefix=PREFIX
+
+If you install in nonstandard place and wont use dictionary for current user
+run::
+
+  $ make prefix=PREFIX install install-local-symlink
+
+To uninstall run one command from list accordingly to installation procedure::
+
+  $ make uninstall
+  $ make uninstall prefix=PREFIX
+  $ make prefix=PREFIX uninstall uninstall-local-symlink
+
+What file needed to create dictionary?
+======================================
+
+.tab_ and .descr, which contain text data in UTF-8 encoding.
+install
+
+In .tab_ file lines which begin with '#' used as comment; space after '\n'
+(two chars) removed.
+
+Words before first TAB character in .tab_ file supposed as translated word,
+rest text after TAB is word article.
+
+.tab_ file format.
+------------------
+
+Used such format:
+
+  WORD [TAB] TRANSLATION [LF]
+
+When processing TRANSLATION string in all occurrence of "\n " (literary
+back-slash small-letter-n and space) removed space.
+
+.descr file format.
+-------------------
+
+First line added to .ifo file as value of description.
+
+Next lines ignored and used for miscellaneous notes.
+
+IPA chars.
+==========
+
+Hare list of spetial IPA chars (code present in UTF-8 encoding):
+
+  θʃŋʧðʒæıʌʊɒɛəɑɜɔˌˈːˑṃṇḷ
+  æɑɒʌәєŋvθðʃʒɚːɡˏˊˋ
+
+You can copy/paste they in phonetic string.
+
+TODO
+----
+::
+
+            Front       Central     Back
+         long  short long  short long  short
+  Close   iː    ɪ                 uː    ʊ
+  Mid           e     ɜː    ə     ɔː
+  Open          æ           ʌ     ɑː    ɒ
+
+      Diphthong          Triphthong
+  Closing    Centring
+   /eɪ/       /ɪə/        /aɪə/
+   /aɪ/       /eə/        /ɑʊə/
+   /ɔɪ/       /ʊə/
+   /əʊ/
+   /aʊ/
+
+Old vs. new transcription.
+--------------------------
+
+From "Better English pronunciation."::
+
+  Old  iː i e ɔː u uː ei ou ai au ɔi æ ɔ ʌ əː ɑː iə ɛə uə ə
+  New  iː ɪ e ɔː ʊ uː eɪ əʊ aɪ aʊ ɔɪ æ ɒ ʌ ɜː ɑː ɪə eə ʊə ə
+
+Also from wikipedia::
+
+  Old  æ e əː ʌɪ ɑʊ ɛə
+  New  a ɛ ɜː aɪ aʊ eə
+
+Emacs.
+------
+
+For entering IPA chars use IPA input method. To enable it type::
+
+  C-u C-\ ipa <enter>
+
+All chars from alphabet typed as usual. How type special chars see below.
+
+For vowel::
+
+  æ ae
+  ɑ o| (small letter o and ) or A (upper letter A)
+  ɒ |o () or /A
+  ʊ U (upper-letter-u)
+  ɛ /3 (slash three)
+  ɔ /c
+  ə /e
+  ʌ /v
+  ɪ I
+
+For consonant::
+
+  θ th
+  ð dh
+  ʃ sh
+  ʒ zh or 3
+  ŋ ng
+
+Special chars::
+
+  ː : (semicolon)
+  ˈ ' (quote)
+  ˌ ` (back quote)
+