X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=README;h=6a6f1e1db94717756179c1ea0e2ff51da772d935;hb=d14fe688e28b8eb1af0c5fa5c805d685631589ac;hp=b8e887aefec0edec71c95793ea903cfb4fbbebab;hpb=c047df29f77f7e1cf7f2bbda3889bcd204bf49b3;p=dbsrgits%2FSQL-Translator.git

diff --git a/README b/README
index b8e887a..6a6f1e1 100644
--- a/README
+++ b/README
@@ -1,18 +1,17 @@
                       SQL::Translator README
 
-The SQLFairy project began with the idea of simplifying the task of
-converting one database create syntax to another through the use of
-Parsers (which understand the source format) and Producers (which
-understand the destination format).  The idea is that any Parser can be
-used with any Producer in the conversion process, so, if you wanted
-Postgres-to-Oracle, you would use the Postgres parser and the Oracle
-producer.  The project has since grown to include parsing structured data
-files like Excel spreadsheets and delimited text files and the
-production of various documentation aids, such as images, graphs, POD,
-and HTML descriptions of the schema, as well as automatic code
-generators through the use of Class::DBI.  Presently only the definition
-parts of SQL are handled (CREATE, ALTER), not the manipulation of data
-(INSERT, UPDATE, DELETE).
+SQL::Translator is a group of Perl modules that converts
+vendor-specific SQL table definitions into other formats, such as
+other vendor-specific SQL, ER diagrams, documentation (POD and HTML),
+XML, and Class::DBI classes.  The main focus of SQL::Translator is
+SQL, but parsers exist for other structured data formats, including
+Excel spreadsheets and arbitrarily delimited text files.  Through the
+separation of the code into parsers and producers with an object model
+in between, it's possible to combine any parser with any producer, to
+plug in custom parsers or producers, or to manipulate the parsed data
+via the built-in object model.  Presently only the definition parts of
+SQL are handled (CREATE, ALTER), not the manipulation of data (INSERT,
+UPDATE, DELETE).
 
 As of version 0.02, parsers exist for the following:
 
@@ -37,10 +36,6 @@ And the following producers exist:
     Sybase: Sybase-specific schema
     XML: structure of the schema described in XML
 
-You can, of course, define your own parsers or producers and pair them
-with existing parsers or producers as long as they adhere to the API
-of the SQL::Translator::Schema object.
-
 Included in this distribution are a few scripts designed to be user
 interfaces for the actual SQL::Translator modules.  In the "bin"
 directory, you will find:
@@ -56,7 +51,7 @@ while the ".cgi" script is a web-form frontend.  The script you'll
 probably find most useful is the "sql_translator.pl" script which is
 meant to be the main interface for translating from text-to-text.  The
 graphic producers, however, have many extra switches, so there are
-scripts specific for each of the the GraphViz an ER-diagram producers.
+scripts specific for each of the the GraphViz and ER-diagram producers.
 All scripts start with "sql" so it will be easier to identify them on
 your system.  All the "*.pl" scripts will be installed in the normal
 installation process, but you'll have to put the CGI script into your
@@ -69,6 +64,16 @@ currently as thorough as it should be, you will definitely get the
 idea of how to parse a file and manipulate the SQL::Translator::Schema
 objects.
 
+INSTALLATION
+
+The regular method:
+
+    $ perl Makefile.PL
+    $ make
+    $ make test
+    $ su -
+    # make install
+
 AUTHORS
 
 Ken Y. Clark, <kclark@cpan.org>, 
@@ -97,3 +102,10 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 BUGS
 
 Please use http://rt.cpan.org/ for reporting bugs.
+
+SEE ALSO
+
+Check out the SQLFairy homepage at Sourceforge for more information,
+mailing lists, etc.:
+
+    http://sqlfairy.sourceforge.net/