Update installation instruction for virtual envs

[sqlconvert.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 01e8420688098a43f00ecf97894279e3d4ce3e53..6e251be67d00a5dbbcd097f267e0ff546d634ca7 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,22 +1,50 @@
-.. 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!
 =====================================
 
+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.
+
+The library is in the early stage of development 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.
+
 Contents:
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
+   install
+   mysql2sql
+   news
 
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
-* :ref:`modindex`
+* `<api/modules.html>`_
 * :ref:`search`
 
+
+Credits
+=======
+
+Created by Oleg Broytman <phd@phdru.name>.
+
+Copyright (C) 2016-2017 PhiloSoft Design.
+
+
+License
+=======
+
+GPL.