Add installation instructions

[sqlconvert.git] / docs / install.rst

diff --git a/docs/install.rst b/docs/install.rst
new file mode 100644 (file)
index 0000000..be16bfd
--- /dev/null
+++ b/docs/install.rst
@@ -0,0 +1,41 @@
+Installation using pip
+======================
+
+System-wide
+-----------
+
+::
+
+    sudo pip install --find-links=http://phdru.name/Software/Python/ --no-index --install-option='-O2' sqlconvert
+
+User mode
+---------
+
+::
+
+    pip install --find-links=http://phdru.name/Software/Python/ --no-index --install-option='-O2' --user sqlconvert
+
+For Python 2.6 the command is easy_install.
+
+Installation from sources
+=========================
+
+To install the library from sources system-wide run run the following
+command:
+
+::
+
+    sudo python setup.py install -O2
+
+If you don't want to install it system-wide you can install it in your
+home directory; run run the following command:
+
+::
+
+    python setup.py install -O2 --user
+
+Option '--user' installs sqlconvert into
+$HOME/.local/lib/python$MAJOR.$MINOR/site-packages/ where python finds it
+automatically. It also installs sqlconvert scripts into $HOME/.local/bin;
+add the directory to your $PATH or move the scripts to a directory in your
+$PATH.