Source

noor / README.txt

Full commit
=============================
 Noor, A python Quran viewer
=============================


Overview
========

Noor_ is a program written in Python_ for viewing quran.  Currently it
contains a GTK interface that uses PyGtk_ library, a CGI interface
that can be used in web servers and a text interface that outputs a
sura to a text file.  Also you can specify translation files; The
translation of each aya is shown after it.

.. _Noor: http://noor.sf.net/
.. _PyGTK: http://www.pygtk.org/
.. _Python: http://www.python.org/


New Features
============

* Changing CGI and GTK interfaces fonts


Getting Started
===============

For using the GTK interface you need to install Python_ and PyGTK_
(they are installed by default in some linux distributions like
Ubuntu).  You can start it by running "noorgtk.py" script either from
the command line or by double clicking it in the extracted folder.
That is, no installation is necessary.

But if you like, you can run "python setup.py install" to install
Noor.  After that you'll be able to run "noorgtk.py" in the terminal
from any location.

Installing the CGI script, "noorcgi.py", is like installing any other
CGI script.  You probably have to copy it to the ``cgi-bin`` directory
of your web server.  Bu before that you should either install noor as
described in the previous paragraph or change the line in
``noorcgi.py`` file which looks like::

  # Add noor to the python path if its not installed:
  sys.path.append('/noor/extracted/folder/')

to point to the folder in which you've extracted noor.  Note that if
you want to use the CGI interface you no longer need to install
PyGTK_.


Adding Translations
-------------------

You can edit the ``~/.noor`` file::

  [common]
  translation = /path/to/translation/file

The translation file can be in two formats.  It can be either a zip
file in the same format as Zekr_ translation files which can be
obtained from http://siahe.com/zekr/resources.html or it can be a
utf-8 text file with translation of each aya in one line.

.. _Zekr: http://siahe.com/zekr


Changing Font
-------------

You can change the GTK or CGI fonts in ``~/.noor`` file::

  [gtk]
  font = nazli 19

  [cgi]
  font = nazli 4


License
=======

This program is under the terms of GNU GPL (GNU General Public
License).  Have a look at ``COPYING`` file for more information.


Source Repository
=================

Noor uses Mercurial_ CMS:

* Main repo: http://noor.sourceforge.net/hg/noor

.. _Mercurial: http://selenic.com/mercurial


Contributing
============

Patches to noor's code are welcome.

Patch style:

* Follow :PEP:`8`.
* Use four spaces for indentation.

You can submit your patches and discuss your ideas in the
`noor-dev [at] googlegroups.com`_ mailing list.

.. _noor-dev [at] googlegroups.com:
   http://groups.google.com/group/noor-dev?hl=en


Thanks
======

Special thanks to Zekr_ project for their nice program.