Move README to rst and cleanup

2 files changed, 94 insertions, 75 deletions

diff --git a/README b/README
deleted file mode 100644
index 6930660..0000000
--- a/README
+++ /dev/null
@@ -1,75 +0,0 @@
-LDTP (http://ldtp.freedesktop.org) works on Windows/Linux/Mac/Solairs/FreeBSD/NetBSD/Palm Source, yes it's a Cross Platform GUI testing tool. Please share your feedback with us (nagappan@gmail.com).
-
-Mandatory requirements
-
-  - GNOME Version - min 2.24
-  - Accessibility should be enabled
-
-Install the following packages
-
-  - pyatspi (python-atspi)
-  - python-twisted-web
-  - python-wnck
-  - python-gnome
-
-Optional dependency packages
-
-  - Python Imaging Library (http://www.pythonware.com/products/pil/) to compare two images
-  - Pystatgrab (http://www.i-scream.org/pystatgrab/) to moitor memory and CPU utilization
-
-Setting up LDTP from source in Linux environment
-
-  - check out source from with the following command: 'git clone https://github.com/ldtp/ldtp2.git'
-  - When prompted for password enter
-  - change to the source directory with the following command: 'cd ldtp2'
-  - build with 'python setup.py build'. Assuming that all the above mentioned packages are installed
-  - setup with 'python setup.py install' as the root user
-
-  Note: If your GNOME version is less than or equal to 2.24, then use LDTPv1 (1.7.x)
-
-LDTP works in the following platforms:
-
-  - http://www.opensuse.org/ OpenSuSE
-  - http://opensolaris.org/ OpenSolaris
-  - http://ubuntu.com/ Ubuntu
-  - http://www.debian.org/ Debian GNU/Linux
-  - http://fedora.redhat.com/ Fedora Core
-  - http://www.freebsd.org/ FreeBSD
-
-How to write test scripts using ldtp for your module?
-
-  - How to create LDTP test scripts in python - http://ldtp.freedesktop.org/wiki/LDTP_test_scripts_in_python
-  - Refer existing pyautosuite test scripts - http://cgit.freedesktop.org/ldtp/pyautosuite/
-  - Refer API Reference page for list of LDTP functions available - http://ldtp.freedesktop.org/user-doc/index.html
-
-How do I contact LDTP team incase of any help?
-
-  - Join the LDTP team on IRC for technical help, online
-    Server  : irc.freenode.net
-    Channel : #ldtp
-  - Join the LDTP Mailing List - http://ldtp.freedesktop.org/wiki/Mailing_20list
-
-If you are interested in contributing to LDTP?
-
-  - You are welcome to do that. Check TODO page and pitch in where ever you can contribute ;) - ping us in the mailing list
-
-For Java compilation:
-
-Download commons-codec-1.6.jar, ws-commons-util-1.0.2.jar, xmlrpc-client-3.1.3.jar, xmlrpc-common-3.1.3.jar and place it in JavaLDTP/lib/
-
-Download jar files from this location or any other apache mirror. Make sure you have the version mentioned in the jar or latest
-http://mirror.cc.columbia.edu/pub/software/apache/commons/codec/binaries/commons-codec-1.6-bin.zip
-http://www.apache.org/dyn/closer.cgi/ws/xmlrpc/
-
-In eclipse its compiled by default. FIXME: Write how to compile from command line
-
-# Note: The following steps created for Windows installer
-To create Ldtp.jar
-
-cd ldtp\JavaLDTP\bin
-jar cvf ..\..\Ldtp.jar * # Note: Tested this on Mac with a forward slash though, haven't created Jar on Windows
-
-To use LDTP Java library:
-
-Include Ldtp.jar file available under ldtp folder in your project
-
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..04aa086
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,94 @@
+====
+LDTP
+====
+
+`LDTP <http://ldtp.freedesktop.org>`_ is the best cross platform GUI testing
+tool out there. Why? Because it works on Linux, Windows, OS X, Solairs,
+FreeBSD, NetBSD, and Palm Source. Your feedback is much appreciated, please
+send an email to `Nagappan <nagappan@gmail.com>`_.
+
+LDTP runs on
+============
+
+ - `OpenSUSE <http://www.opensuse.org/>`_
+ - `OpenSolaris <http://opensolaris.org/>`_
+ - `Ubuntu <http://ubuntu.com/>`_
+ - `Debian <http://www.debian.org/>`_
+ - `Fedora <http://fedoraproject.org/>`_
+ - `FreeBSD <http://www.freebsd.org/>`_
+
+Requirements
+============
+
+DE Requirements
+---------------
+ - GNOME Version - min 2.24
+ - Accessibility enabled
+
+Dependencies
+------------
+
+ - pyatspi (python-atspi)
+ - python-twisted-web
+ - python-wnck
+ - python-gnome
+
+Optional Dependencies
+---------------------
+
+ - Python Imaging Library (http://www.pythonware.com/products/pil/) to compare two images
+ - Pystatgrab (http://www.i-scream.org/pystatgrab/) to monitor memory and CPU utilization
+
+Build LDTP on Linux
+===================
+
+First checkout ldtp from github and cd into ldtp2.
+
+.. code-block:: none
+   git clone https://github.com/ldtp/ldtp2.git
+   cd ldtp2/
+
+Then build and install.
+
+.. code-block:: none
+   python setup.py build
+   sudo python setup.py build
+
+Note: If your GNOME version is less than or equal to 2.24, then use LDTPv1 (1.7.x)
+
+Writing tests
+=============
+
+It is best to read the documentation, so first cd into the doc directory.
+
+.. code-block:: none
+   cd ldtp2/doc/
+
+Then you can either read ldtp-tutorial.rst in you favorite text editor or build
+a pdf.
+
+.. code-block:: none
+   yum install rst2pdf #or
+   apt-get update; apt-get install rst2pdf
+   rst2pdf ldtp-tutorial.rst
+
+Then open the pdf in your favorite pdf viewer.
+
+You can also refer to the following for more information:
+
+`Writing LDTP test scripts in Python scripting language <http://ldtp.freedesktop.org/wiki/LDTP_test_scripts_in_python>`_
+`LDTP API Reference page <http://ldtp.freedesktop.org/user-doc/index.html>`_
+
+Contact LDTP
+============
+
+We are in #ldtp on irc.freenode.net and are also available on the `LDTP mailing
+list <http://ldtp.freedesktop.org/wiki/Mailing_20list>`_
+
+Contributing
+============
+
+So you want to help? Fantastic! If you are looking for ideas on what to work on
+ask on the mailing list or ping us in irc, we love meeting new people.
+
+Generally the process is fork https://github.com/ldtp/ldtp2, make your changes, and make a pull request.