added autogenerated files for easier development checkout

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

virtualsmartcard/doc/README.rst

@@ -0,0 +1,77 @@
+.. highlight:: sh
+
+.. _PBKDF2: https://www.dlitz.net/software/python-pbkdf2/
+.. _PCSC-lite: http://pcsclite.alioth.debian.org/
+.. _PCSC-lite: http://pcsclite.alioth.debian.org/
+.. _PIP: http://www.pythonware.com/products/pil/
+.. _PyCrypto: http://pycrypto.org/
+.. _Python: http://www.python.org/
+.. _cyberflex-shell: https://github.com/henryk/cyberflex-shell
+.. _pyscard: http://pyscard.sourceforge.net/
+
+.. |vpicc| replace:: :abbr:`vpicc (virtual smart card)`
+.. |vpcd| replace:: :abbr:`vpcd (virtual smart card reader)`
+
+
+********************************************************************************
+Virtual Smart Card
+********************************************************************************
+
+:Authors:
+    - Frank Morgner <morgner@informatik.hu-berlin.de>
+    - Dominik Oepen <oepen@informatik.hu-berlin.de>
+:License:
+    GPL version 3
+:Tested Platforms:
+    - Linux (Debian, Ubuntu, OpenMoko)
+    - Windows (only |vpicc|, not |vpcd|)
+:Potential Platforms:
+    Unix-like operating systems (Mac OS, Solaris, BSD, ...)
+
+Welcome to the Virtual Smart Card. The purpose of the Virtual Smart Card is to emulate a
+smart card and make it accessible through PCSC. Currently the virtual smart
+card supports almost all commands of ISO-7816 including secure messaging.
+Besides a plain ISO-7816 smart card it is also possible to emulate a German
+ePass (only basic access control) and a rudimentary Cryptoflex smart card. The
+|vpicc| can be accessed through the |vpcd| which is a driver for
+:command:`pcscd` of PCSC-Lite_.
+
+By default the vicc communicates with the vpcd through a socket on localhost
+port 35963. The file :file:`utils.py` was taken from Henryk Plötz's
+cyberflex-shell_.
+
+
+.. include:: autotools.rst
+
+Depending on your usage of the |vpicc| you might or might not need
+the following:
+
+- Python_
+- pyscard_
+- PyCrypto_
+- PBKDF2_
+- PIP_
+
+The |vpcd| has the following dependencies:
+
+- PCSC-Lite_
+
+
+================================================================================
+Running the Virtual Smart Card
+================================================================================
+
+First you need to make sure that pcscd loads the |vpcd|. You might need to run
+:command:`update-reader.conf` to update pcscd's configuration file. Then
+:command:`pcscd -f -d` should say something like "Attempting startup of
+Virtual PCD"
+
+Now you can run :command:`vicc` which connects to the |vpcd|. The command
+:command:`vicc --help` gives an overview about the command line options.
+
+You should now be able to access the |vpicc| through the system's
+PC/SC API via |vpcd|/pcscd. You can use the opensc-explorer or pcsc_scan to test
+that.
+
+
+.. include:: questions.rst

virtualsmartcard/doc/autotools.rst

@@ -0,0 +1,20 @@
+.. highlight:: sh
+
+=============
+Installation
+=============
+
+The Virtual Smart Card uses the GNU Build System to compile and install. If you are
+unfamiliar with it, please have a look at :file:`INSTALL`. If you have a look
+around and can not find it, you are probably working bleeding edge in the
+repository.  Run the following command in :file:`virtualsmartcard` to
+get the missing standard auxiliary files::
+    
+    autoreconf -i
+
+To configure (:command:`configure --help` lists possible options), build and
+install the Virtual Smart Card now do the following::
+    
+    ./configure
+    make
+    make install

virtualsmartcard/doc/questions.rst

@@ -0,0 +1,6 @@
+========
+Question
+========
+
+Do you have questions, suggestions or contributions? Feedback of any kind is
+more than welcome! Please use our `project trackers <http://sourceforge.net/projects/vsmartcard/support>`_.