README.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Thu, 12 Jul 2012 23:19:49 +0300
changeset 234 ea850dc51cd5
parent 233 d3670cd252ce
child 235 4a96c81d6c23
permissions -rw-r--r--
Update info about reposting issue.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
69
580cc720c496 Fix RST syntax.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 65
diff changeset
     1
.. -*- fill-column: 78 -*-
11
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     2
206
407f2a82ef26 Include common header for quick links. Exclude unnecessary .html files from build.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 147
diff changeset
     3
.. include:: header.rst
407f2a82ef26 Include common header for quick links. Exclude unnecessary .html files from build.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 147
diff changeset
     4
135
8abf567d9a76 Fix header text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 117
diff changeset
     5
======================
8abf567d9a76 Fix header text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 117
diff changeset
     6
 gadict dictionaries.
8abf567d9a76 Fix header text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 117
diff changeset
     7
======================
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
     8
.. contents::
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
     9
109
5bb58b8d87a7 Add version info into documentation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 100
diff changeset
    10
Document version.
5bb58b8d87a7 Add version info into documentation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 100
diff changeset
    11
=================
5bb58b8d87a7 Add version info into documentation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 100
diff changeset
    12
5bb58b8d87a7 Add version info into documentation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 100
diff changeset
    13
.. include:: VERSION.rst
5bb58b8d87a7 Add version info into documentation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 100
diff changeset
    14
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    15
About gadict.
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    16
=============
99
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 95
diff changeset
    17
223
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    18
``gadict`` is a collection of en-ru dictionaries and some freely available
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    19
English thesaurus.
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    20
223
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    21
Also project provide some useful information. Check the `sitemap
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    22
<index.html#sitemap>`_.
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    23
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    24
Home page.
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    25
==========
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    26
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    27
  http://gadict.sourceforge.net/
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    28
                Home page.
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    29
  http://sourceforge.net/p/gadict/
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    30
                SourceForge home page.
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    31
  http://sourceforge.net/projects/gadict
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    32
                SourceForge (old look) home page.
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    33
223
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    34
Project goals.
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    35
==============
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    36
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    37
 * Create and maintain good quality EN-RU dictionaries.
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    38
 * Host some free dictionaries (to make them available to broad auditory).
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    39
 * 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
    40
 * 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
    41
   and maintaining dictionaries.
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    42
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    43
Target audience.
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    44
================
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    45
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    46
 * 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
    47
 * 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
    48
   techniques.
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    49
224
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    50
Project quality.
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    51
================
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    52
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    53
Currently dictionaries have very small size and less useful. You can see
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    54
`statistics <STAT.html>`_ on articles count.
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    55
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    56
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
    57
sometimes with free dictionaries.
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    58
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    59
But *gadict-irregular-verbs-en-ru* dictionary contain mostly all irregular
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    60
verbs.
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    61
225
ef894029e70d Add "Project history".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 224
diff changeset
    62
Project history.
ef894029e70d Add "Project history".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 224
diff changeset
    63
================
ef894029e70d Add "Project history".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 224
diff changeset
    64
ef894029e70d Add "Project history".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 224
diff changeset
    65
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
    66
ef894029e70d Add "Project history".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 224
diff changeset
    67
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
    68
much verbose C5 dictfmt format.
ef894029e70d Add "Project history".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 224
diff changeset
    69
230
eb6a42645e24 Small text improvement.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    70
Licensing, term of use.
eb6a42645e24 Small text improvement.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    71
=======================
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    72
230
eb6a42645e24 Small text improvement.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    73
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
    74
warranty.
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    75
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    76
See LICENSE_ file.
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    77
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    78
.. _LICENSE: LICENSE.html
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    79
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    80
Download page.
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    81
==============
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    82
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    83
  https://sourceforge.net/projects/gadict/files/
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    84
                gadict source releases at SourceForge.
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    85
234
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    86
Reporting issue.
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    87
================
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    88
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    89
Just mail me <gavenkoa@gmail.com>.
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    90
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    91
Fill bug reports and suggestions in Trac instance by:
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
  TODO
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    94
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    95
Don't forget add your email address to ticket *CC* field to be notified on
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    96
ticket changes!
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    97
117
e6d8558c54c7 ohloh home page for gadict
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 116
diff changeset
    98
Software directory.
e6d8558c54c7 ohloh home page for gadict
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 116
diff changeset
    99
===================
e6d8558c54c7 ohloh home page for gadict
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 116
diff changeset
   100
e6d8558c54c7 ohloh home page for gadict
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 116
diff changeset
   101
  https://www.ohloh.net/p/gadict
e6d8558c54c7 ohloh home page for gadict
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 116
diff changeset
   102
                ohloh home page for gadict
e6d8558c54c7 ohloh home page for gadict
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 116
diff changeset
   103