summaryrefslogtreecommitdiff
path: root/docs/build/front.rst
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2011-11-20 22:03:09 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2011-11-20 22:03:09 -0500
commit0124904dd2300caf03e1c2119f4169569a931138 (patch)
tree7fd5b97cdfbfafb577022f9943cf97c236c9874a /docs/build/front.rst
parent5e209347f37627769daa0986a18a8ca6f0d21183 (diff)
downloadalembic-0124904dd2300caf03e1c2119f4169569a931138.tar.gz
add front matter
Diffstat (limited to 'docs/build/front.rst')
-rw-r--r--docs/build/front.rst45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/build/front.rst b/docs/build/front.rst
new file mode 100644
index 0000000..854e475
--- /dev/null
+++ b/docs/build/front.rst
@@ -0,0 +1,45 @@
+============
+Front Matter
+============
+
+Information about the Alembic project.
+
+Project Homepage
+================
+
+Alembic is hosted on `Bitbucket <http://bitbucket.org>`_ - the lead project page is at https://bitbucket.org/zzzeek/alembic. Source
+code is tracked here using `Mercurial <http://mercurial.selenic.com/>`_.
+
+Releases and project status are available on Pypi at http://pypi.python.org/pypi/alembic.
+
+The most recent published version of this documentation should be at http://packages.python.org/alembic/.
+
+.. _installation:
+
+Installation
+============
+
+Install released versions of Alembic from the Python package index with `pip <http://pypi.python.org/pypi/pip>`_ or a similar tool::
+
+ pip install alembic
+
+Installation via source distribution is via the ``setup.py`` script::
+
+ python setup.py install
+
+The install will add the ``alembic`` command to the environment. All operations with Alembic
+then proceed through the usage of this command.
+
+Community
+=========
+
+Alembic is developed by `Mike Bayer <http://techspot.zzzeek.org>`_, and is
+loosely associated with the `SQLAlchemy <http://www.sqlalchemy.org/>`_ and `Pylons <http://www.pylonsproject.org>`_
+projects.
+As Alembic's usage increases, it is anticipated that the SQLAlchemy mailing list and IRC channel
+will become the primary channels for support.
+
+Bugs
+====
+Bugs and feature enhancements to Alembic should be reported on the `Bitbucket
+issue tracker <https://bitbucket.org/zzzeek/alembic/issues?status=new&status=open>`_.