Commits

Ali Gholami Rudi  committed 34a293f

0.2

  • Participants
  • Parent commits d82ce08
  • Tags 0.2

Comments (0)

Files changed (3)

 Getting Started
 ===============
 
-For using the GTK interface you need to install Python_ and PyGTK_,
-first (they are installed by default in some linux distributions like
+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.
 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.  Note that before that you should either install noor
-as described in the previous paragraph or change the line which looks
-like::
+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('/home/ali/projects/noor')
+  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
 .. _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
 ======
 

File docs/index.txt

 You can download Noor from http://sf.net/projects/noor/files
 
 
+Feedback
+========
+
+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
+
+
 Source Repository
 =================
 
 * Main repo: http://noor.sourceforge.net/hg/noor
 
 
-Feedback
-========
-
-Send your bug reports, feature requests and patches in noors's
-`sourceforge.net project page`_.
-
-
 .. _Noor: http://noor.sf.net/
 .. _PyGTK: http://www.pygtk.org/
 .. _Python: http://www.python.org/

File docs/todo.txt

 TODO
 ====
 
+* Specifying a separate font for translation
+* Changing to ``A minimal Quran viewer``?
 * Better noortest
-* Changing to ``A minimal Quran viewer``?
 
 
 noorgtk
 -------
 
+* Documenting movement keys
 * Better line wrapping
 * Using text box instead of a label