www/README.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Wed, 01 Jun 2016 15:38:48 +0300
changeset 485 e63f5429f3de
parent 339 4d8d46bbe30d
child 488 ed62b3cef9ce
permissions -rw-r--r--
Refine docs.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
243
deede3c3386f Add coding to RST files.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 235
diff changeset
     1
.. -*- coding: utf-8 -*-
206
407f2a82ef26 Include common header for quick links. Exclude unnecessary .html files from build.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 147
diff changeset
     2
485
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
     3
=====================
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
     4
 gadict dictionaries
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
     5
=====================
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
     6
.. contents::
301
1439e072640a Remove CSS hack that suppress displaying document name in TOC by
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 276
diff changeset
     7
   :local:
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
     8
485
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
     9
About gadict
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    10
============
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    11
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    12
``gadict`` is a small collection of EN to EN/RU/UK dictionaries.
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    13
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    14
Also project provide some linguistic information for English language. Check the
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    15
`sitemap <index.html#sitemap>`_.
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    16
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    17
Home page
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    18
=========
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    19
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    20
http://gadict.sourceforge.net/
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    21
  Home page.
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    22
http://sourceforge.net/p/gadict/
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    23
  SourceForge home page.
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    24
http://sourceforge.net/projects/gadict
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    25
  SourceForge (old look) home page.
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    26
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    27
Project goals
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    28
=============
99
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 95
diff changeset
    29
485
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    30
 * Maintain some EN to EN/RU/UK dictionaries.
223
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    31
 * Provide all data in most liberal restrictions (public domain).
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    32
 * Supply additional information about English language and tools for creating
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    33
   and maintaining dictionaries.
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    34
485
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    35
Target audience
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    36
===============
223
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    37
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    38
 * Regular users for using dictionaries and reading articles.
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    39
 * Dictionary develpers for checking dictionary building and maintaining
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    40
   techniques.
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    41
485
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    42
Project quality
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    43
===============
224
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    44
485
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    45
See `statistics <STAT.html>`_ on articles count for different dictionaries.
224
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    46
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    47
I check spelling and translation of most words with old learning books and
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    48
sometimes with free dictionaries.
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    49
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    50
But *gadict-irregular-verbs-en-ru* dictionary contain mostly all irregular
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    51
verbs.
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    52
485
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    53
Project history
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    54
===============
225
ef894029e70d Add "Project history".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 224
diff changeset
    55
ef894029e70d Add "Project history".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 224
diff changeset
    56
Project born in 2009-06-28 as collection of irregular verbs which I learn.
ef894029e70d Add "Project history".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 224
diff changeset
    57
ef894029e70d Add "Project history".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 224
diff changeset
    58
It use inconvenient for editing Stardict TAB format. Later project switched to
ef894029e70d Add "Project history".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 224
diff changeset
    59
much verbose C5 dictfmt format.
ef894029e70d Add "Project history".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 224
diff changeset
    60
485
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    61
Term of use
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    62
===========
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    63
230
eb6a42645e24 Small text improvement.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    64
Generally speak: all files released for free use without any restrictions and
eb6a42645e24 Small text improvement.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    65
warranty.
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    66
339
4d8d46bbe30d Move RST files to separate directory. Build HTML files out of sources
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 301
diff changeset
    67
See `<LICENSE.html>`_ file.
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    68
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    69
Download page.
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    70
==============
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    71
235
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 234
diff changeset
    72
Check `Obtaining instructions <INSTALL.html#obtaining>`_.
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 234
diff changeset
    73
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    74
  https://sourceforge.net/projects/gadict/files/
235
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 234
diff changeset
    75
                gadict releases at SourceForge.
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 234
diff changeset
    76
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 234
diff changeset
    77
Installation instructions.
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 234
diff changeset
    78
==========================
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 234
diff changeset
    79
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 234
diff changeset
    80
Check `Installation instructions <INSTALL.html>`_.
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    81
485
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    82
Documentation
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    83
=============
276
66db1bbebe45 Generalise RST build code. Remove index.rst, use README.rst instead.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 243
diff changeset
    84
66db1bbebe45 Generalise RST build code. Remove index.rst, use README.rst instead.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 243
diff changeset
    85
 * `Statistics on count of articles in gadict dictionaries <STAT.html>`_.
66db1bbebe45 Generalise RST build code. Remove index.rst, use README.rst instead.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 243
diff changeset
    86
 * `English punctuation <en-punctuation_en.html>`_.
66db1bbebe45 Generalise RST build code. Remove index.rst, use README.rst instead.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 243
diff changeset
    87
 * `English pronunciation <en-pronunciation_en.html>`_.
66db1bbebe45 Generalise RST build code. Remove index.rst, use README.rst instead.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 243
diff changeset
    88
 * `English pronunciation on Russian <en-pronunciation_ru.html>`_.
66db1bbebe45 Generalise RST build code. Remove index.rst, use README.rst instead.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 243
diff changeset
    89
485
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    90
Reporting issue
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    91
===============
234
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    92
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    93
Just mail me <gavenkoa@gmail.com>.
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    94
485
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    95
Software directories
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    96
====================
234
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    97
485
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    98
https://www.ohloh.net/p/gadict
e63f5429f3de Refine docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 339
diff changeset
    99
  ohloh home page for gadict
117
e6d8558c54c7 ohloh home page for gadict
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 116
diff changeset
   100