[svn-commits] tzafrir: branch 1.4 r2706 - in /branches/1.4: Makefile README

[SVN commits to the Digium repositories]

Author: tzafrir
Date: Sun Jul  8 07:09:59 2007
New Revision: 2706

URL: http://svn.digium.com/view/zaptel?view=rev&rev=2706
Log:
* README fixes.
* Add makefile target to generate README.html from README with asciidoc.

Note: At least for now the ability to generate a nice extra HTML copy of
the text README is an extra feature. But the README file is meant to be
primarily read as a text file and will still be readable as such till
further notice.

Modified:
    branches/1.4/Makefile
    branches/1.4/README

Modified: branches/1.4/Makefile
URL: http://svn.digium.com/view/zaptel/branches/1.4/Makefile?view=diff&rev=2706&r1=2705&r2=2706
==============================================================================
--- branches/1.4/Makefile (original)
+++ branches/1.4/Makefile Sun Jul  8 07:09:59 2007
@@ -359,6 +359,9 @@
 
 stackcheck: checkstack modules
 	./checkstack *.ko */*.ko
+
+README.html: README
+	asciidoc -n -a toc $<
 
 MISDNVERSION=1_1_3
 MISDNUSERVERSION=1_1_3

Modified: branches/1.4/README
URL: http://svn.digium.com/view/zaptel/branches/1.4/README?view=diff&rev=2706&r1=2705&r2=2706
==============================================================================
--- branches/1.4/README (original)
+++ branches/1.4/README Sun Jul  8 07:09:59 2007
@@ -3,7 +3,7 @@
 Asterisk Development Team <asteriskteam at digium.com>
 $Revision$, $Date$
 
-Zaptel is a short for ZAPata Telephony.
+Zaptel is a short for ZAPata TELephony.
 
 Supported Hardware
 ------------------
@@ -77,15 +77,17 @@
 Kernel Configuration
 ~~~~~~~~~~~~~~~~~~~~
 If you build a custom kernel, note the following configuration items:
+
 - CONFIG_CRC_CCITT must be enabled ('y' or 'm'). On 2.6 kernels this can 
   be selected These can be selected from the "Library Routines" submenu 
   during kernel configuration via "make menuconfig".
-- ztdummy on i386/amd64 and later kernels (>= 2.6.15) can (and should)
-  use the system's RTC (Real Time Clock).
-- Alternatives to that for ztdummy are a UHCI USB controller (USB
-  controllers made by Intel or VIA) or a kernel that has HZ=1000
-  (default on kernels 2.6.0-2.6.12, optional on newer kernels. Not
-  possible on 2.4).
+- If you don't have any zaptel hardware, you need ztdummy.
+  * ztdummy on i386/amd64 and later kernels (>= 2.6.15) can (and should)
+    use the system's RTC (Real Time Clock).
+  * Alternatives to that for ztdummy are a UHCI USB controller (USB
+    controllers made by Intel or VIA) or a kernel that has HZ=1000
+    (default on kernels 2.6.0-2.6.12, optional on newer kernels. Not
+    possible on 2.4).
 
 
 A Build System
@@ -108,11 +110,9 @@
 Some libraries are needed for extra utilities that are provided with
 Zaptel
 
-- libusb is needed for building fpgaload, needed for firmware loading of
+- libusb is needed for building fpga_load, needed for firmware loading of
   the Xorcom Astribank.
 - libnewt is needed to build the optional but useful utility zttool.
-- For building usbfxstest you will need the zapata library. TODO:
-  Needed?
 
 Installing the first two on Debian:
 
@@ -160,7 +160,7 @@
 
 To get usage information on a program, you can also use perldoc
 (sometimes provided in a package separate from perl itself). For
-instalnce:
+instance:
 
   perldoc ./xpp/utils/xpp_blink