update readme
authorHarald Welte <laforge@gnumonks.org>
Sat, 27 May 2006 17:46:58 +0000 (17:46 +0000)
committerHarald Welte <laforge@gnumonks.org>
Sat, 27 May 2006 17:46:58 +0000 (17:46 +0000)
git-svn-id: https://svn.gnumonks.org/trunk/librfid@1802 e0336214-984f-0b4b-a45f-81c69e1f0ede

README

diff --git a/README b/README
index c67a48a..b479c16 100644 (file)
--- a/README
+++ b/README
@@ -39,14 +39,38 @@ don't hesitate to contact me.
 
 3. Installation
 
-In order to run librfid, you need to provide a PC_to_RDR_Escape function to it.
-This is the low-level transport function for communicating.   Usually that function would point to a CCID device driver.
+In order to run librfid, you need a reader transport backend that provides a
+PC_to_RDR_Escape function.  The current version of this library offers two backends
 
-My svn repository at
-https://svn.gnumonks.org/trunk/omnikey_cardman/new/userspace/ has an openct
-fork with a modified CCID driver.  It allows you to use the contact based part
-via PC/SC, CT-API, and the contactless part via librfid simultaneously.
+3.1 (new) native CCID backend
 
+If you add the '--with-ccid' option to the './configure' command, then the new
+native CCID driver (courtesy of Werner Koch) will be linked into the library.
+This requires a working libusb with development headers.  
+
+In order to use the reader, you will need to set the permissions of the respective
+/proc/bus/usb or /sys/bus/usb files (or run the application as root, if you
+trust my code, which you shouldn't).
+
+3.2 (old) OpenCT backend
+
+This backend has the advantage that it will allow you to use the contact-based
+part and the contactless part of the CM5121 simultaneously.  However, it requires
+a patched version of OpenCT.
+
+A patch against openct-0.6.7 is available as openct-0.6.7-librfid.patch.
+
+Please note that while librfid in this configuration _uses_ OpenCT as a
+lower-layer transport interface, it doesn't actually provide a virtual reader
+interface to it, i.e. you can't use CT-API/OpenCT/PCSC API's to access RFID
+transponders.
+
+4. Testing
+
+In the 'utils' directory, you will get a 'librfid-tool' binary.  It is very
+minimalistic, and mainly an example on how to use the librfid api. For an ICAO
+compliant passport, you may try "--protocol tcl".  For a mifare ultralight transponder,
+"--protocol mifare-ultralight" will give you a full dump of the transponder.
 
 -- Harald Welte <laforge@gnumonks.org>