www/README.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Sun, 13 Mar 2016 18:20:35 +0200
changeset 339 4d8d46bbe30d
parent 301 README.rst@1439e072640a
child 485 e63f5429f3de
permissions -rw-r--r--
Move RST files to separate directory. Build HTML files out of sources directory. New template for HTML files. `dist` target is broken.
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
135
8abf567d9a76 Fix header text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 117
diff changeset
     3
======================
8abf567d9a76 Fix header text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 117
diff changeset
     4
 gadict dictionaries.
8abf567d9a76 Fix header text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 117
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
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
     9
About gadict.
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    10
=============
99
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 95
diff changeset
    11
223
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    12
``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
    13
English thesaurus.
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    14
223
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    15
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
    16
<index.html#sitemap>`_.
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    17
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    18
Home page.
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    19
==========
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    20
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    21
  http://gadict.sourceforge.net/
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    22
                Home page.
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    23
  http://sourceforge.net/p/gadict/
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    24
                SourceForge home page.
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    25
  http://sourceforge.net/projects/gadict
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    26
                SourceForge (old look) home page.
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    27
223
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    28
Project goals.
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    29
==============
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    30
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    31
 * 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
    32
 * 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
    33
 * 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
    34
 * 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
    35
   and maintaining dictionaries.
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
Target audience.
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    38
================
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    39
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    40
 * 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
    41
 * 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
    42
   techniques.
f47a43d4fad3 Delete outdated info. Update about section, project goals and target audience.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 220
diff changeset
    43
224
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    44
Project quality.
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    45
================
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
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
    48
`statistics <STAT.html>`_ on articles count.
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
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
    51
sometimes with free dictionaries.
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
But *gadict-irregular-verbs-en-ru* dictionary contain mostly all irregular
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    54
verbs.
4c4304581de7 Add "Project quality".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 223
diff changeset
    55
225
ef894029e70d Add "Project history".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 224
diff changeset
    56
Project history.
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
ef894029e70d Add "Project history".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 224
diff changeset
    59
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
    60
ef894029e70d Add "Project history".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 224
diff changeset
    61
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
    62
much verbose C5 dictfmt format.
ef894029e70d Add "Project history".
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 224
diff changeset
    63
230
eb6a42645e24 Small text improvement.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    64
Licensing, term of use.
eb6a42645e24 Small text improvement.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    65
=======================
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    66
230
eb6a42645e24 Small text improvement.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 226
diff changeset
    67
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
    68
warranty.
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    69
339
4d8d46bbe30d Move RST files to separate directory. Build HTML files out of sources
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 301
diff changeset
    70
See `<LICENSE.html>`_ file.
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    71
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    72
Download page.
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    73
==============
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    74
235
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 234
diff changeset
    75
Check `Obtaining instructions <INSTALL.html#obtaining>`_.
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 234
diff changeset
    76
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    77
  https://sourceforge.net/projects/gadict/files/
235
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 234
diff changeset
    78
                gadict releases at SourceForge.
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
Installation instructions.
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 234
diff changeset
    81
==========================
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 234
diff changeset
    82
4a96c81d6c23 Obtaining instructions.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 234
diff changeset
    83
Check `Installation instructions <INSTALL.html>`_.
116
09391dc786c4 Add project hosting info.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
    84
276
66db1bbebe45 Generalise RST build code. Remove index.rst, use README.rst instead.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 243
diff changeset
    85
Documentation.
66db1bbebe45 Generalise RST build code. Remove index.rst, use README.rst instead.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 243
diff changeset
    86
==============
66db1bbebe45 Generalise RST build code. Remove index.rst, use README.rst instead.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 243
diff changeset
    87
66db1bbebe45 Generalise RST build code. Remove index.rst, use README.rst instead.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 243
diff changeset
    88
 * `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
    89
 * `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
    90
 * `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
    91
 * `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
    92
234
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    93
Reporting issue.
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
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    96
Just mail me <gavenkoa@gmail.com>.
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    97
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    98
Fill bug reports and suggestions in Trac instance by:
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
    99
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
   100
  TODO
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
   101
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
   102
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
   103
ticket changes!
ea850dc51cd5 Update info about reposting issue.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 233
diff changeset
   104
117
e6d8558c54c7 ohloh home page for gadict
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 116
diff changeset
   105
Software directory.
e6d8558c54c7 ohloh home page for gadict
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 116
diff changeset
   106
===================
e6d8558c54c7 ohloh home page for gadict
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 116
diff changeset
   107
e6d8558c54c7 ohloh home page for gadict
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 116
diff changeset
   108
  https://www.ohloh.net/p/gadict
e6d8558c54c7 ohloh home page for gadict
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 116
diff changeset
   109
                ohloh home page for gadict
e6d8558c54c7 ohloh home page for gadict
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 116
diff changeset
   110