Update the README:

* Update modules list
* Add a basic list of utilities.
* Clarify the location of the kernel source tree.


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

1 files changed, 46 insertions, 6 deletions

diff --git a/README b/README
index a97f2fe..764e76e 100644
--- a/README
+++ b/README
@@ -17,9 +17,14 @@ To install:
 Here is a list of what module to use with what hardware
 
 Module Name	Hardware
+===========     ========
+pciradio        PCI Radio Card Zaptel
+
 tor2		T400P - Quad Span T1 Card
 		E400P - Quad Span E1 Card
 
+torisa		Old Tormenta1 ISA Card
+
 wct4xxp		TE405P - Quad Span T1/E1 Card (5v version)
 		TE410P - Quad Span T1/E1 Card (3.3v version)
 
@@ -31,15 +36,36 @@ wcte11xp	TE110P - Single Span T1/E1 Card
 wcfxo		X100P - Single port FXO interface
 		X101P - Single port FXO interface 
 
-wctdm or	TDM400P - Modular FXS/FXO interface (1-4 ports)
-wcfxs
+wctdm   	TDM400P - Modular FXS/FXO interface (1-4 ports)
 
-wcusb or	S100U - Single port FXS USB Interface
-wcfxsusb	
+wctdm24xxp      TDM800P -  Modular FXS/FXO interface (up to 8 ports)
+                TDM2400P - Modular FXS/FXO interface (up to 24 ports)
 
-torisa		Old Tormenta1 ISA Card
+wcusb   	S100U - Single port FXS USB Interface
+
+xpp             the Astribank USB channel bank
+
+ztd-eth         TDM-over-ethernet
+
+ztd-loc         Dynamic local spans
 
-ztdummy		UHCI USB Zaptel Timing Only Interface
+ztdummy		Zaptel Timing Only Interface
+
+
+The module "zaptel" is required by all others. "ztdynamic" is required by 
+ztd-eth and by ztd-loc.
+
+Helper Utilities
+================
+This directory includes many helper utilities. Some of them are more 
+useful for debugging. The more useful ones of them:
+
+ztcfg       Configure zaptel spans / channels.
+zttool      Watch and monitor zaptel spans (also: cat /proc/zaptel/* ).
+ztmonitor   Monitor (visually or to the speaker) or record a zaptel channel.
+zttest      Test the zaptel timing source.
+fxotune     Tune some characteristics of the FXO chip to reduce generated echo.
+torisatool  A tool to configure the old torisa cards. Others don't need it.
 
 
 What is the license for the zaptel driver?
@@ -66,6 +92,20 @@ 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.
 
+Q. Do I need to set up the symbolic link /usr/src/linux ?
+A. That depends.
+
+* On Debian Sarge: apt-get install kernel-headers-`uname -r`
+* On Ubuntu and newer Debian: apt-get install linux-headers-`uname -r`
+* On Redhat, Fedora, Centos: install the package  'kernel-devel' or 
+  'kernel-smp-devel' (depending on your kernel versions).
+* If you have just installed a kernel.org kernel from source, chances
+  are also that things will Just Work[tm].
+
+This is because the build process checks for /lib/modules/`uname -r`/build
+before /usr/src/linux . This linux will also be valid if you installed a 
+non-ancient kernel from source, and haven't reconfigured the source tree.
+
 How do I report bugs or contribute?
 ===================================
 Please report bug and patches to the Asterisk.org bug tracker at