rearrange distribution more cleanly

makinacorpus · Nov 15, 2012 · 2f98d9d · 2f98d9d
1 parent b2b7a0e
commit 2f98d9d
Show file tree

Hide file tree

Showing 33 changed files with 394 additions and 83 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -0,0 +1,7 @@
+Changelog
+=============
+
+0.0 (unreleased)
+-----------------
+
+-  Initial version
diff --git a/CHANGES.txt b/CHANGES.txt
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,2 +1,8 @@
-include *.txt *.ini *.cfg *.rst
+include *.txt *.ini *.cfg *.rst *.in
-recursive-include convertit *.ico *.png *.css *.gif *.jpg *.pt *.txt *.mak *.mako *.js *.html *.xml
+exclude .installed.cfg a.cfg .mr* local.cfg
+recursive-include src *.ico *.png *.css *.gif *.jpg *.pt *.txt *.mak *.mako *.js *.html *.xml
+recursive-include etc *
+recursive-exclude etc/init.d *
+recursive-exclude etc/apache 100-*
+recursive-exclude etc/wsgi *
+recursive-exclude etc *.env
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,78 @@
+Convertit
+=========
+
+A conversion webservice.
+
+.. contents::
+
+Feedback
+========
+
+Open an `Issue <https://github.com/makinacorpus/convertit/issues>`_ to report a bug or request a new feature.
+
+Dependencies
+============
+* for OpenDocument support: unoconv
+* for SVG support: inkscape
+
+Install
+=======
+* Download and extract a released tarball from `pypi <http://pypi.python.org/pypi/convertit>`_
+* The bleeding edge version is hosted on github ::
+
+    git clone https://github.com/makinacorpus/convertit.git
+
+* PreInstall it ::
+
+    cd convertit
+    python bootstrap.py -dc buildout-dev.cfg
+
+
+Development
+============
+::
+    cd convertit
+    bin/buildout -Nc buildout-dev.cfg
+    pserve --reload etc/wsgi/instance.ini
+    bin/scripts setup.py test
+
+Once the application is running, you may visit http://localhost:6543/ in your browser.
+
+Production
+===========
+::
+    cd convertit
+    bin/buildout -Nc buildout-prod.cfg
+    bin/supervisord
+    bin/supervisorctl status
+
+
+Some files have been generated in etc/ for your convenience:
+
+    * An init script
+    * A logrotate configuration
+    * An Apache vhost sample
+
+
+Credits
+========
+Companies
+---------
+|makinacom|_
+
+  * `Planet Makina Corpus <http://www.makina-corpus.org>`_
+  * `Contact us <mailto:python@makina-corpus.org>`_
+
+.. |makinacom| image:: http://depot.makina-corpus.org/public/logo.gif
+.. _makinacom:  http://www.makina-corpus.com
+
+Authors
+------------
+* Antoine Cezar
+* Alex Marandon
+
+Contributors
+-----------------
+* kiorky  <kiorky@cryptelium.net>
+
+