* Correct names for Digium cards.

 * Further removed obsolete sections.
 * Section about the perl stuff added.


git-svn-id: http://svn.digium.com/svn/zaptel/branches/1.4@2664 5390a7c7-147a-4af0-8ec9-7488f05a26cb

1 files changed, 33 insertions, 31 deletions

diff --git a/README b/README
index 7ac7827..5eb29a2 100644
--- a/README
+++ b/README
@@ -7,13 +7,13 @@ Zaptel is a short for ZAPata Telephony.
 
 Supported Hardware
 ------------------
-PRI Cards
-~~~~~~~~~
+Digital Cards
+~~~~~~~~~~~~~
 - wct4xxp: 
-  - Digium newer quad-span T1/E1 cards: Wildcard TE420P/TE410P/TE405P 
-  - Digium newer dual-span T1/E1 cards: Wildcard TE220P/TE210P/TE425P 
-- wcte12xp: Digium Wildcard TE12xP single-span T1/E1 card
-- wcte11xp: Digium Wildcard TE110P T1/E1
+  - Digium newer quad-span T1/E1/J1 cards: Wildcard TE420P/TE410P/TE405P 
+  - Digium newer dual-span T1/E1/J1 cards: Wildcard TE220P/TE210P/TE205P 
+- wcte12xp: Digium Wildcard TE120P and the TE122P single-span T1/E1/J1 card
+- wcte11xp: Digium Wildcard TE110P T1/E1/J1
 - wct1xxp: 
   - Wildcard T100P (old single-span T1)
   - Wildcard E100P (old single-span E1)
@@ -30,7 +30,7 @@ Analog Cards
 - xpp: Xorcom Astribank: a USB connected unit of up to 32 ports
   (also BRI)
 - wcfxo: X100P, similar and clones. A simple single-port FXO card
-- wcfxs: Digium S100U: A simple single-port USB FXS unit
+- wcusb: Digium S100U: A simple single-port USB FXS unit
 
 
 Other Drivers
@@ -127,30 +127,42 @@ Installation
 ------------
 
   ./configure
-  # optional step: 
+  # optional step: select custom configuration:
   #make menuconfig
+  # optional step: enable zaptel-perl
   make
   make install
   # To install init scripts and config files:
   #make config
 
 
+Zaptel PERL modules
+-------------------
+The directory xpp/utils has, in addition to helper utilities for the
+Xorcom Astribank, a collection of perl modules to provide information
+related to Zaptel. The perl modules themselves are under xpp/utils/zconf .
+In xpp/utils there are several utilities that use those modules:
+- xpp-specific: zt_registration, xpp_sync, xpp_blink .
+- General: lszaptel, zapconf, zaptel_hardware
+
+Those utilities require the perl modules to be installed, however they
+will also look for them in the directory zconf, and thus can be run
+directly from the zaptel source tree. For example:
+
+  ./xpp/utils/zaptel_hardware
 
-Note:
-See
-http://www.voip-info.org/wiki/view/Asterisk+Zaptel+Installation
-for more verbose and updated version of this document.
+The modules and utilities are not installed by default in this version
+of zaptel . In order to get them installed, you need do the following
+before running 'make install': remove the '#' in the line that sets 
+PERLLIBDIR in xpp/utils/Makefile . This can be done by e.g.:
 
-Requirements:
-	Some of the testing programs still require the zapata library
-	The zttool program requires libnewt
+  sed -i -e 's/^#\(PERLLIBDIR\)/\1/' xpp/utils/Makefile
 
-To install:
-	check zconfig.h for any specific configuration changes
-	make
-	make install
+To get usage information on a program, you can also use perldoc
+(sometimes provided in a package separate from perl itself). For
+instalnce:
 
-Here is a list of what module to use with what hardware
+  perldoc ./xpp/utils/xpp_blink
 
 
 What is the license for the zaptel driver?
@@ -165,22 +177,12 @@ under more flexible terms can be readily obtained through Digium, Inc.
 at reasonable cost.
 
 
-Brief F.A.Q
------------
-Q. Zaptel compiled with no errors but when I try to modprobe zaptel I
-receive "FATAL: Error insering zaptel (/lib/modules/2.6.x.x/misc/zaptel.ko):
-Unknown symbol in module or unknown parameter (see dmesg)
-
-A. You need to recompile your kernel with CONFIG_CRC_CCITT=y or
-CONFIG_CRC_CCITT=m. To do this, run 'make menuconfig' and change it under 
-'Library Routines -> CRC-CCIT functions'. If you compiled it as a module,
-load it, otherwise reboot.
-
 How do I report bugs or contribute?
 -----------------------------------
 Please report bug and patches to the Asterisk.org bug tracker at
 http://bugs.digium.com in the "zaptel" category.
 
+
 Does anything use this library so far?
 --------------------------------------
 Yes, the Asterisk Open Source PBX does. http://www.asterisk.org