Started documentation

diff --git a/README.txt b/README.txt
index a70e97069eba7c8cfc4ee11bc44a9f385cfaa095..64b1299f4800a9735a6d09dc435e4c0dc3c6ec10 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -7,3 +7,5 @@ convert mysqldump (especially with extended INSERT syntax) to standard
 SQL to load at least to PostgreSQL or SQLite.
 
 Uses sqlparse to parse SQL.
 SQL to load at least to PostgreSQL or SQLite.
 
 Uses sqlparse to parse SQL.

+
+The program is in its initial phase and currently cannot do much.

diff --git a/docs/index.rst b/docs/index.rst
index 01e8420688098a43f00ecf97894279e3d4ce3e53..06beefeadd404f62a65c1c9fb1767084a36e3848 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,11 +6,31 @@
 Welcome to mysql2sql's documentation!
 =====================================
 
 Welcome to mysql2sql's documentation!
 =====================================
 

-Contents:
+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.

 
 

-.. toctree::
-   :maxdepth: 2
+It uses `sqlparse <https://github.com/andialbrecht/sqlparse>`_ to parse
+SQL.

 
 

+The program is in its initial phase and currently cannot do much.
+
+.. highlight:: none
+
+Command line
+------------
+
+mysql-to-sql.py
+~~~~~~~~~~~~~~~
+
+Usage::
+
+    mysql-to-sql.py [-i infile] [-o outfile]
+
+Options::
+
+    -i, --infile infile    Input file, stdin if absent
+    -o, --outfile outfile  Output file, stdout if absent

 
 
 Indices and tables
 
 
 Indices and tables


@@ -20,3 +40,16 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
 * :ref:`modindex`
 * :ref:`search`
 

+
+Credits
+=======
+
+Created by Oleg Broytman <phd@phdru.name>.
+
+Copyright (C) 2016 PhiloSoft Design.
+
+
+License
+=======
+
+GPL.