updated documentation

ccid/doc/README.txt.in

@@ -126,12 +126,6 @@ tools.
     \texttt{/dev/gadget/ep3-bulk}\\};
 
 
-
-.. include:: download.txt
-
-
-.. include:: autotools.txt
-
 Running the @PACKAGE_NAME@ has the following dependencies:
 
 - Linux Kernel with GadgetFS_
@@ -143,6 +137,12 @@ needs a usable PC/SC middleware with USB CCID driver. This is the case for most
 modern Windows and Unix-like systems by default.
 
 
+.. include:: download.txt
+
+
+.. include:: autotools.txt
+
+
 =================
 Hints on GadgetFS
 =================

doc/autotools.txt.in

@@ -4,6 +4,11 @@
 Installation
 ************
 
+
+=======================================
+Installation on Linux, Unix and similar
+=======================================
+
 The @PACKAGE_NAME@ uses the GNU Build System to compile and install. If you are
 unfamiliar with it, please have a look at :file:`INSTALL`. If you can not find
 it, you are probably working bleeding edge in the repository.  Run the

doc/download.txt.in

@@ -4,7 +4,9 @@
 Download
 ********
 
-You can find the latest release of @PACKAGE_NAME@ on `Sourceforge
+You can find the latest release of @PACKAGE_NAME@ on `Github
+<https://github.com/frankmorgner/vsmartcard/releases>`_. Older releases are
+still available on `Sourceforge
 <http://sourceforge.net/projects/vsmartcard/files>`_.
 
 Alternatively, you can clone our git repository::

doc/index.txt

@@ -332,7 +332,9 @@ Download
 --------
 
 You can download the latest release of the |vsmartcard| `here
-<http://sourceforge.net/projects/vsmartcard/files>`_.
+<https://github.com/frankmorgner/vsmartcard/releases>`_. Older releases are
+still available at the `old project
+location <http://sourceforge.net/projects/vsmartcard/files>`_.
 
 Alternatively, you can clone our git repository::
 

npa/doc/README.txt

@@ -59,6 +59,12 @@ compatible with OpenSC.
         (libnpa) edge (openpace);
     \end{pgfonlayer}
 
+The nPA Smart Card Library has the following dependencies:
+
+- OpenPACE_
+- OpenSC_
+- OpenSSL_
+
 
 .. include:: download.txt
 
@@ -67,12 +73,6 @@ compatible with OpenSC.
 
 .. include:: autotools.txt
 
-The nPA Smart Card Library has the following dependencies:
-
-- OpenPACE_
-- OpenSC_
-- OpenSSL_
-
 
 ====================================
 Installation of OpenPACE and OpenSSL

npa/doc/README.txt.in

@@ -59,6 +59,12 @@ compatible with OpenSC.
         (libnpa) edge (openpace);
     \end{pgfonlayer}
 
+The @PACKAGE_NAME@ has the following dependencies:
+
+- OpenPACE_
+- OpenSC_
+- OpenSSL_
+
 
 .. include:: download.txt
 
@@ -67,12 +73,6 @@ compatible with OpenSC.
 
 .. include:: autotools.txt
 
-The @PACKAGE_NAME@ has the following dependencies:
-
-- OpenPACE_
-- OpenSC_
-- OpenSSL_
-
 
 ====================================
 Installation of OpenPACE and OpenSSL

npa/doc/autotools.txt

@@ -4,6 +4,11 @@
 Installation
 ************
 
+
+=======================================
+Installation on Linux, Unix and similar
+=======================================
+
 The nPA Smart Card Library uses the GNU Build System to compile and install. If you are
 unfamiliar with it, please have a look at :file:`INSTALL`. If you can not find
 it, you are probably working bleeding edge in the repository.  Run the

npa/doc/download.txt

@@ -4,7 +4,9 @@
 Download
 ********
 
-You can find the latest release of nPA Smart Card Library on `Sourceforge
+You can find the latest release of nPA Smart Card Library on `Github
+<https://github.com/frankmorgner/vsmartcard/releases>`_. Older releases are
+still available on `Sourceforge
 <http://sourceforge.net/projects/vsmartcard/files>`_.
 
 Alternatively, you can clone our git repository::

pcsc-relay/doc/README.txt

@@ -40,6 +40,10 @@ With PC/SC Relay you can relay a contact-less or contact based smart card
 over a long distance. Also you can use it in combination with the :ref:`vicc`
 to completely emulate an ISO/IEC 14443 smart card.
 
+PC/SC Relay has the following dependencies:
+
+- PC/SC middleware
+- libnfc_
 
 
 .. include:: relay-note.txt
@@ -50,10 +54,6 @@ to completely emulate an ISO/IEC 14443 smart card.
 
 .. include:: autotools.txt
 
-PC/SC Relay has the following dependencies:
-
-- PC/SC middleware
-- libnfc_
 
 ===============
 Hints on libnfc

pcsc-relay/doc/README.txt.in

@@ -40,6 +40,10 @@ With @PACKAGE_NAME@ you can relay a contact-less or contact based smart card
 over a long distance. Also you can use it in combination with the :ref:`vicc`
 to completely emulate an ISO/IEC 14443 smart card.
 
+@PACKAGE_NAME@ has the following dependencies:
+
+- PC/SC middleware
+- libnfc_
 
 
 .. include:: relay-note.txt
@@ -50,10 +54,6 @@ to completely emulate an ISO/IEC 14443 smart card.
 
 .. include:: autotools.txt
 
-@PACKAGE_NAME@ has the following dependencies:
-
-- PC/SC middleware
-- libnfc_
 
 ===============
 Hints on libnfc

pcsc-relay/doc/autotools.txt

@@ -4,6 +4,11 @@
 Installation
 ************
 
+
+=======================================
+Installation on Linux, Unix and similar
+=======================================
+
 The PC/SC Relay uses the GNU Build System to compile and install. If you are
 unfamiliar with it, please have a look at :file:`INSTALL`. If you can not find
 it, you are probably working bleeding edge in the repository.  Run the

pcsc-relay/doc/download.txt

@@ -4,7 +4,9 @@
 Download
 ********
 
-You can find the latest release of PC/SC Relay on `Sourceforge
+You can find the latest release of PC/SC Relay on `Github
+<https://github.com/frankmorgner/vsmartcard/releases>`_. Older releases are
+still available on `Sourceforge
 <http://sourceforge.net/projects/vsmartcard/files>`_.
 
 Alternatively, you can clone our git repository::

virtualsmartcard/doc/README.txt

@@ -95,6 +95,16 @@ The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_.
         ;
     \end{pgfonlayer}
 
+Depending on your usage of the |vpicc| you may need to install the following:
+
+- Python_
+- pyscard_
+- PyCrypto_
+- PBKDF2_
+- PIP_
+- readline_ or PyReadline_
+- OpenPACE_ (nPA emulation)
+
 
 .. include:: download.txt
 
@@ -103,16 +113,6 @@ The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_.
 
 .. include:: autotools.txt
 
-Depending on your usage of the |vpicc| you might or might not need
-the following:
-
-- Python_
-- pyscard_
-- PyCrypto_
-- PBKDF2_
-- PIP_
-- OpenPACE_ (nPA emulation)
-
 
 ================================================================================
 Building and installing |vpcd| on Windows
@@ -125,7 +125,8 @@ Building and installing |vpcd| on Windows
 
 For the Windows integration we extended `Fabio Ottavi's UMDF Driver for a
 Virtual Smart Card Reader`_ with a |vpcd| interface. To build |vpcd| for
-Windows we use `Windows Driver Kit 8.1 and Visual Studio 2013`_:
+Windows we use `Windows Driver Kit 8.1 and Visual Studio 2013`_. If you choose
+to download the `Windows binaries`_, you may directly jump to step 3.
 
 
 1. In Visual Studio select :menuselection:`File --> Open --> Convert
@@ -221,8 +222,13 @@ Currently it is not possible to configure the Windows driver to connect to an
 Running |vpicc|
 ================================================================================
 
-The command :command:`vicc --help` gives an overview about the command line
+The compiled `Windows binaries`_ of |vpicc| include OpenPACE. The other
-options of |vpicc|.
+dependencies listed above need to be installed seperately. You can start the
+|vpicc| via :command:`python.exe vicc.py`. On all other systems an executable
+script :command:`vicc` is installed using the autotools.
+
+The |vpicc| option :option:`--help` gives an overview about the command line
+switches:
 
 .. program-output:: vicc --help
 
@@ -233,13 +239,6 @@ options of |vpicc|.
     :command:`vpcd-config` also prints a QR code for configuration of the
     :ref:`remote-reader`.
 
-On Windows you can start |vpicc| with :command:`python.exe src/vpicc/vicc.in`
-or :command:`python.exe vicc`. Note emulating the German ID card
-(:option:`--type nPA`) when running |vpicc| on Windows is currently not
-supported, because OpenPACE's Python bindings are untested for Windows.
-However, it is possible to connect an emulated ID card running on Linux to a
-|vpcd| running on Windows.
-
 When |vpcd| and |vpicc| are connected you should be able to access the card
 through the PC/SC API. You can use the :command:`opensc-explorer` or
 :command:`pcsc_scan` for testing. In Virtual Smart Card's root directory we also
@@ -265,8 +264,11 @@ Notes and References
 .. _pyscard: http://pyscard.sourceforge.net/
 .. _PyCrypto: http://pycrypto.org/
 .. _PBKDF2: https://www.dlitz.net/software/python-pbkdf2/
+.. _readline: https://docs.python.org/3.3/library/readline.html
+.. _PyReadline: https://pypi.python.org/pypi/pyreadline
 .. _PIP: http://www.pythonware.com/products/pil/
 .. _OpenPACE: https://github.com/frankmorgner/openpace
 .. _`Fabio Ottavi's UMDF Driver for a Virtual Smart Card Reader`: http://www.codeproject.com/Articles/134010/An-UMDF-Driver-for-a-Virtual-Smart-Card-Reader
 .. _`Windows Driver Kit 8.1 and Visual Studio 2013`: http://msdn.microsoft.com/en-us/windows/hardware/hh852365.aspx
 .. _`Microsoft's Kernel-Mode Code Signing Walkthrough`: http://msdn.microsoft.com/en-us/library/windows/hardware/dn653569%28v=vs.85%29.aspx
+.. _`Windows binaries`: https://github.com/frankmorgner/vsmartcard/releases/download/virtualsmartcard-0.7/virtualsmartcard-0.7_win32.zip

virtualsmartcard/doc/README.txt.in

@@ -95,16 +95,7 @@ The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_.
         ;
     \end{pgfonlayer}
 
-
+Depending on your usage of the |vpicc| you may need to install the following:
-.. include:: download.txt
-
-
-.. _vicc_install:
-
-.. include:: autotools.txt
-
-Depending on your usage of the |vpicc| you might or might not need
-the following:
 
 - Python_
 - pyscard_
@@ -115,6 +106,14 @@ the following:
 - OpenPACE_ (nPA emulation)
 
 
+.. include:: download.txt
+
+
+.. _vicc_install:
+
+.. include:: autotools.txt
+
+
 ================================================================================
 Building and installing |vpcd| on Windows
 ================================================================================
@@ -126,7 +125,8 @@ Building and installing |vpcd| on Windows
 
 For the Windows integration we extended `Fabio Ottavi's UMDF Driver for a
 Virtual Smart Card Reader`_ with a |vpcd| interface. To build |vpcd| for
-Windows we use `Windows Driver Kit 8.1 and Visual Studio 2013`_:
+Windows we use `Windows Driver Kit 8.1 and Visual Studio 2013`_. If you choose
+to download the `Windows binaries`_, you may directly jump to step 3.
 
 
 1. In Visual Studio select :menuselection:`File --> Open --> Convert
@@ -222,8 +222,13 @@ Currently it is not possible to configure the Windows driver to connect to an
 Running |vpicc|
 ================================================================================
 
-The command :command:`vicc --help` gives an overview about the command line
+The compiled `Windows binaries`_ of |vpicc| include OpenPACE. The other
-options of |vpicc|.
+dependencies listed above need to be installed seperately. You can start the
+|vpicc| via :command:`python.exe vicc.py`. On all other systems an executable
+script :command:`vicc` is installed using the autotools.
+
+The |vpicc| option :option:`--help` gives an overview about the command line
+switches:
 
 .. program-output:: vicc --help
 
@@ -234,13 +239,6 @@ options of |vpicc|.
     :command:`vpcd-config` also prints a QR code for configuration of the
     :ref:`remote-reader`.
 
-On Windows you can start |vpicc| with :command:`python.exe src/vpicc/vicc.in`
-or :command:`python.exe vicc`. Note emulating the German ID card
-(:option:`--type nPA`) when running |vpicc| on Windows is currently not
-supported, because OpenPACE's Python bindings are untested for Windows.
-However, it is possible to connect an emulated ID card running on Linux to a
-|vpcd| running on Windows.
-
 When |vpcd| and |vpicc| are connected you should be able to access the card
 through the PC/SC API. You can use the :command:`opensc-explorer` or
 :command:`pcsc_scan` for testing. In @PACKAGE_NAME@'s root directory we also
@@ -273,3 +271,4 @@ Notes and References
 .. _`Fabio Ottavi's UMDF Driver for a Virtual Smart Card Reader`: http://www.codeproject.com/Articles/134010/An-UMDF-Driver-for-a-Virtual-Smart-Card-Reader
 .. _`Windows Driver Kit 8.1 and Visual Studio 2013`: http://msdn.microsoft.com/en-us/windows/hardware/hh852365.aspx
 .. _`Microsoft's Kernel-Mode Code Signing Walkthrough`: http://msdn.microsoft.com/en-us/library/windows/hardware/dn653569%28v=vs.85%29.aspx
+.. _`Windows binaries`: https://github.com/frankmorgner/vsmartcard/releases/download/virtualsmartcard-0.7/virtualsmartcard-0.7_win32.zip

virtualsmartcard/doc/autotools.txt

@@ -4,6 +4,11 @@
 Installation
 ************
 
+
+=======================================
+Installation on Linux, Unix and similar
+=======================================
+
 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 can not find
 it, you are probably working bleeding edge in the repository.  Run the

virtualsmartcard/doc/download.txt

@@ -4,7 +4,9 @@
 Download
 ********
 
-You can find the latest release of Virtual Smart Card on `Sourceforge
+You can find the latest release of Virtual Smart Card on `Github
+<https://github.com/frankmorgner/vsmartcard/releases>`_. Older releases are
+still available on `Sourceforge
 <http://sourceforge.net/projects/vsmartcard/files>`_.
 
 Alternatively, you can clone our git repository::