[Pkg-haskell-commits] [SCM] haskell-testpack branch, master, updated. debian/1.0.2-1-4-gb0d6b36

[John Goerzen]

The following commit has been merged in the master branch:
commit c4417454e1db35c42e8d6530eaf1c2aba819806b
Author: John Goerzen <jgoerzen at complete.org>
Date:   Wed Oct 6 09:17:23 2004 +0100

    Added INSTALL, README files
    
    
    
    (jgoerzen at complete.org--projects/missingh--head--1.0--patch-32)

diff --git a/ChangeLog b/ChangeLog
index 09d0e63..0964265 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -2,6 +2,21 @@
 # arch-tag: automatic-ChangeLog--jgoerzen at complete.org--projects/missingh--head--1.0
 #
 
+2004-10-06 03:17:23 GMT	John Goerzen <jgoerzen at complete.org>	patch-32
+
+    Summary:
+      Added INSTALL, README files
+    Revision:
+      missingh--head--1.0--patch-32
+
+
+    new files:
+     INSTALL README
+
+    modified files:
+     ChangeLog debian/docs
+
+
 2004-10-05 22:01:05 GMT	John Goerzen <jgoerzen at complete.org>	patch-31
 
     Summary:
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..3eccb52
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,37 @@
+INSTALLATION INSTRUCTIONS
+
+There are several methods:
+
+1. Using Cabal -- recommended, especially for ghc users
+
+2. Using hmake -- not yet supported
+
+3. Manual
+
+--------------------------
+Cabal
+--------------------------
+
+First, install the Cabal distribution for your favorite compiler.
+Get it from http://www.haskell.org/cabal.  Debian users can
+apt-get install libghc6-cabal-dev.  Then run "make setup" (you may
+need to edit the Makefile if you don't use GHC).
+
+Then:
+
+ ./setup configure
+ ./setup build
+ ./setup install
+
+-------------------------
+Manual
+-------------------------
+
+Edit the Makefile to support your compiler.  The Makefile will
+require GNU make.  Type "make" or "gmake".  Copy the library and .hs or .hi
+files to the appropriate locations.  That may be all that you need to do.
+
+(More to come in this file)
+
+# arch-tag: Installation Instructions
+
diff --git a/README b/README
new file mode 100644
index 0000000..0420b13
--- /dev/null
+++ b/README
@@ -0,0 +1,70 @@
+-------------------------
+What is MissingH?
+-------------------------
+
+It's a collection of Haskell-related utilities.  It is an extension of my
+earlier work developing MissingLib for OCaml.  The following modules are
+are provided at this time, and more are likely to follow:
+
+IOutil                  * Copying data between files or handles
+                        * Lazy operations on line input
+                        * Binary I/O with Haskell strings
+                        * Lazy operations on binary blocks
+
+Listutil                * Association list manipulation
+                        * List splitting and delimiter joining
+                        * Truncation
+
+Strutil                 * Leading/trailing whitespace removal
+                        * Beginning/ending tests
+                        * Joining, splitting, and truncation
+
+
+The entire library has no prerequisites save the Haskell standard library and
+findlib and is designed to install without complexity on a variety of systems.
+It could also easily be embedded within your own source trees so that users
+need not have it installed beforehand.
+
+** THIS IS CURRENTLY ALPHA-QUALITY CODE; MAJOR API FLUCTUATIONS MAY YET OCCUR.
+
+-------------------------
+Quick Start
+-------------------------
+
+See the file INSTALL.
+
+-------------------------
+Usage in programs
+-------------------------
+
+You can simply use -package MissingH in most compilers to enable
+this library.  
+
+The API docs can be built with "make doc", or you can find them at:
+
+http://quux.org/devel/missingh
+
+-------------------------
+Author & Homepage
+-------------------------
+
+MissingH was written by John Goerzen <jgoerzen at complete.org>.
+
+The latest version may be obtained at:
+
+   gopher://quux.org/1/devel/missingh
+
+or:
+
+   http://quux.org/devel/missingh
+
+Documentation is also available on that page.
+
+This program is copyrighted under the terms of the GNU General Public License.
+See the COPYRIGHT and COPYING files for more details.
+
+If the GPL is unacceptable for your uses, please e-mail me; alternative
+terms can be negotiated for your project.
+
+arch-tag: general information
+
diff --git a/debian/docs b/debian/docs
index e69de29..e845566 100644
--- a/debian/docs
+++ b/debian/docs
@@ -0,0 +1 @@
+README

-- 
haskell-testpack