Update installation instruction for virtual envs

[sqlconvert.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 49cb311151e8825fa19315cc6b91e54dcf2e4a1d..6e251be67d00a5dbbcd097f267e0ff546d634ca7 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,53 +1,31 @@
-.. mysql2sql documentation master file, created by
+.. sqlconvert documentation master file, created by
    sphinx-quickstart on Fri Jul 22 19:32:24 2016.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to mysql2sql's documentation!
+Welcome to sqlconvert's documentation!
 =====================================
 
-This is mysql2sql, a mysql to sql converter. It is primary intended to
-convert mysqldump (especially with extended INSERT syntax) to standard
-SQL to load at least to PostgreSQL or SQLite.
+sqlconvert is a library to implement SQL converters. It uses `sqlparse
+<https://github.com/andialbrecht/sqlparse>`_ to parse SQL and `SQLObject
+<http://sqlobject.org/>`_ to escape SQL strings and handle connections to
+DB backends.
 
-It uses `sqlparse <https://github.com/andialbrecht/sqlparse>`_ to parse
-SQL.
+The library is in the early stage of development and currently cannot do
+much.
 
-The program is in its initial phase and currently cannot do much.
+The library is accompanied with `mysql2sql <mysql2sql.html>`_, a script
+intended primarily to convert mysqldump (especially with extended INSERT
+syntax) to standard SQL to load at least to PostgreSQL or SQLite.
 
-.. highlight:: none
+Contents:
 
-Command line
-------------
+.. toctree::
+   :maxdepth: 1
 
-mysql-to-sql.py
-~~~~~~~~~~~~~~~
-
-Usage::
-
-    mysql-to-sql.py [-e encoding] [-E output_encoding] [infile] [[-o] outfile]
-
-Options::
-
-   -e ENCODING, --encoding ENCODING
-                           input/output encoding, default is utf-8
-   -E OUTPUT_ENCODING, --output-encoding OUTPUT_ENCODING
-                           separate output encoding, default is the same as
-                           `-e` except for console; for console output charset
-                           from the current locale is used
-    infile                 Input file, stdin if absent or '-'
-    -o, --outfile outfile  Output file, stdout if absent or '-'
-
-Option `-o` is useful when infile is absent (input is redirected), for
-example::
-
-    mysql-to-sql.py -o outfile.sql < infile.sql
-    cat infile.sql | mysql-to-sql.py -o outfile.sql
-
-But of course it simple can be::
-
-    mysql-to-sql.py - outfile.sql < infile.sql
-    cat infile.sql | mysql-to-sql.py - outfile.sql
+   install
+   mysql2sql
+   news
 
 
 Indices and tables
@@ -63,7 +41,7 @@ Credits
 
 Created by Oleg Broytman <phd@phdru.name>.
 
-Copyright (C) 2016 PhiloSoft Design.
+Copyright (C) 2016-2017 PhiloSoft Design.
 
 
 License