Converted most of the documentation to reStructuredText in order to be able to sphinx for documentation

git-svn-id: https://vsmartcard.svn.sourceforge.net/svnroot/vsmartcard@545 96b47cad-a561-4643-ad3b-153ac7d7599c

doc/index.rst

@@ -6,14 +6,30 @@
 Welcome to Virtual Smartcard Architecture's documentation!
 ==========================================================
 
+Welcome to vsmartcard. vsmartcard is an umbrella project for various projects concerned with the emulation of different types of smart card readers or smart cards themselves.
+
+Currently the following projects are part of vsmartcard: 
+
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
    ccid
+   pcsc-relay
+   virtualsmartcard
 
-Lorem ipsum
+Download
+========
+
+You can download the latest release of vsmartcard here.
+
+Alternatively you can check out the source code from our subversion repository. 
+
+Contribute
+==========
+
+If you want to contribute to the vsmartcard project you're more than welcome. You can file bugs or submit patches using our bugtracker. 
 
 Indices and tables
 ==================

doc/pcsc-relay.rst

@@ -0,0 +1 @@
+../pcsc-relay/README

doc/virtualsmartcard.rst

@@ -0,0 +1 @@
+../virtualsmartcard/README

pcsc-relay/README

@@ -1,9 +1,11 @@
-Title            : pcsc-relay
+**********
-Authors          : Dominik Oepen <oepen@informatik.hu-berlin.de>
+pcsc-relay
-                   Frank Morgner <morgner@informatik.hu-berlin.de>
+**********
-Version          : 0.2 2010-12-08
+
-License          : See file COPYING
+.. Authors          : Dominik Oepen <oepen@informatik.hu-berlin.de>
-Tested Platforms : Linux 2.6 (Debian, Ubuntu, Om 2008)
+..                    Frank Morgner <morgner@informatik.hu-berlin.de>
+.. License          : See file COPYING
+.. Tested Platforms : Linux 2.6 (Debian, Ubuntu, Om 2008)
 
 Welcome to pcsc-relay. The purpose of pcsc-relay is to forward APDUs from the
 OpenPICC or from a libnfc device to a smart card via the PCSC middleware. You
@@ -11,13 +13,13 @@ can use this program in combination with the virtual smart card to emulate a
 ISO/IEC 14443 smart card. 
 
 
-INSTALLATION
+Installation
 ------------
 
 See file INSTALL.
 
 
-QUESTIONS
+Questions
 ---------
 
 For questions, please use http://sourceforge.net/projects/vsmartcard/support

virtualsmartcard/README

@@ -1,9 +1,11 @@
-Title            : virtualsmartcard
+******************************
-Authors          : Frank Morgner <morgner@informatik.hu-berlin.de>
+Virtual Smartcard Architecture
-                   Dominik Oepen <oepen@informatik.hu-berlin.de>
+******************************
-Version          : 0.3 2010-13-08
+
-License          : See file COPYING
+.. Authors          : Frank Morgner <morgner@informatik.hu-berlin.de>
-Tested Platforms : Linux 2.6 (Debian, Ubuntu, Om 2008)
+..                    Dominik Oepen <oepen@informatik.hu-berlin.de>
+.. License          : See file COPYING
+.. Tested Platforms : Linux 2.6 (Debian, Ubuntu, Om 2008)
 
 Welcome to virtualsmartcard. The purpose of virtualsmartcard is to emulate a
 smart card and make it accessible through PCSC. Currently the virtual smart
@@ -18,29 +20,29 @@ reader through a socket on localhost port 35963. The file utils.py was taken
 from Henryk Plötz's cyberflex-shell.
 
 
-INSTALLATION
+Installation
 ------------
 
 See file INSTALL.
 
 
-RUNNING virtualsmartcard
+Running virtualsmartcard
 ------------------------
 
 First you need to make sure that pcscd loads the virtual smart card driver. You
-might run `update-reader.conf` to update pcscd's configuration file. Then
+might run ``update-reader.conf`` to update pcscd's configuration file. Then
-`pcscd -f -d` should say something like
+``pcscd -f -d`` should say something like
 readerfactory.c:1024:RFInitializeReader() Attempting startup of Virtual PCD 00 00 using /usr/lib/pcsc/drivers/serial/libvpcd.so
 
-Now you can run `virtualsmartcard` which connects to the virtual reader. The
+Now you can run ``vicc`` which connects to the virtual reader. The
-command `virtualsmartcard --help` gives an overview about the command line
+command ``vicc --help`` gives an overview about the command line
 options.
 
 You should now be able to access the virtual smart card through the system's
 PC/SC API. You can use the opensc-explorer or pcsc_scan to test that.
 
 
-QUESTIONS
+Question
 ---------
 
 For questions, please use http://sourceforge.net/projects/vsmartcard/support