adding a README

diadara · Sep 19, 2013 · 8cb8a82 · 8cb8a82
1 parent 01d93d5
commit 8cb8a82
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -0,0 +1,11 @@
+INDICDICTIONARY
+================
+
+A bilingual dictionary for indic languages.
+
+Run tests with python setup.py tests.
+
+Dictionary module has render module as a requirement which requires
+pango cairo and pangocairo installed in your system.
+
+Read the `docs <http://indicdictionary.readthedocs.org/en/latest/>`_ for more
diff --git a/docs/index.rst b/docs/index.rst
@@ -16,7 +16,10 @@ Usage
  >>> print d.getdef("cat","en-ml").encode('utf-8')
  'cat\n   \t1. \xe0\xb4\xaa\xe0\xb5\x82\xe0\xb4\x9a\xe0\xb5\x8d\xe0\xb4\x9a\n   \t2. \xe0\xb4\xae\xe0\xb4\xbe\xe0\xb4\xb0\xe0\xb5\x8d\xe2\x80\x8d\xe0\xb4\x9c\xe0\xb5\x8d\xe0\xb4\x9c\xe0\xb4\xbe\xe0\xb4\xb0\xe0\xb4\xa8\xe0\xb5\x8d\xe2\x80\x8d\n'
 
-I
+Dependancies
+------------
+Indicdictionary requires render module for creating images.This requires you
+to have pango, cairo,and pangocairo installed in your system.
 
 API reference
 --------------