Add project hosting info.
authorOleksandr Gavenko <gavenkoa@gmail.com>
Fri, 13 Jan 2012 00:25:09 +0200
changeset 116 09391dc786c4
parent 115 1c6ffaecdf50
child 117 e6d8558c54c7
Add project hosting info.
README.rst
--- a/README.rst	Fri Jan 13 00:04:09 2012 +0200
+++ b/README.rst	Fri Jan 13 00:25:09 2012 +0200
@@ -10,8 +10,8 @@
 
 .. include:: VERSION.rst
 
-About.
-======
+About gadict.
+=============
 
 I create and update these dictionaries when learn English.
 
@@ -20,6 +20,83 @@
 I check spelling and translation of most words with old learning books and
 sometimes with free dictionaries.
 
+Target audience.
+================
+
+Currently dictionaries have very small word count so not useful.
+
+But *gadict-irregular-verbs-en-ru* dictionary contain mostly all irregular
+verbs.
+
+Project goal.
+=============
+
+Create and maintain good quality EN-RU, RU-EN dictionaries.
+
+Home page.
+==========
+
+  http://gadict.sourceforge.net/
+                Home page.
+  http://sourceforge.net/p/gadict/
+                SourceForge home page.
+  http://sourceforge.net/projects/gadict
+                SourceForge (old look) home page.
+
+License statement.
+==================
+
+All files released for free use without any restrictions and warranty.
+
+See LICENSE_ file.
+
+.. _LICENSE: LICENSE.html
+
+Versioning rules.
+=================
+
+We use **major.minor** schema.
+
+Until we reach 5000 words **major** is 0. **minor** updated from time to time.
+
+Getting sources (VCS).
+======================
+
+To clone repository run::
+
+  $ hg clone http://hg.code.sf.net/p/gadict/code gadict-hg
+
+To push to repository you must have write permission and do::
+
+  $ hg push ssh://$USER@hg.code.sf.net/p/gadict/code
+
+or::
+
+  $ hg clone https://$USER@hg.code.sf.net/p/gadict/code
+
+Browsing sources.
+=================
+
+  http://hg.code.sf.net/p/gadict/code
+                hgweb interface for official repository.
+  https://sourceforge.net/p/gadict/code/
+                Sourceforge Allure interface for official repository.
+
+Download page.
+==============
+
+  https://sourceforge.net/projects/gadict/files/
+                gadict source releases at SourceForge.
+
+Report bug (BTS).
+=================
+
+Fill bug reports and suggestions in Trac instance by
+https://sourceforge.net/apps/trac/gadict/newticket
+
+Don't forget add your email address to ticket *CC* field to be notified on
+ticket changes!
+
 How install/uninstall?
 ======================