From 648454fffccf6c6c8674bd77ef90f75b34e2b4e0 Mon Sep 17 00:00:00 2001
From: Holger Frey <mail@holgerfrey.de>
Date: Thu, 5 Oct 2017 13:36:44 +0200
Subject: [PATCH] added more documentation

---
 AUTHORS.rst         |  7 +++++++
 HISTORY.rst         |  8 +++++++-
 README.rst          | 43 ++++++++++++++++++++++++++++++++++++++-----
 setup.py            |  8 ++++----
 tests/test_ordr2.py | 25 -------------------------
 5 files changed, 56 insertions(+), 35 deletions(-)
 delete mode 100644 tests/test_ordr2.py

diff --git a/AUTHORS.rst b/AUTHORS.rst
index 88a33cb..a895e70 100644
--- a/AUTHORS.rst
+++ b/AUTHORS.rst
@@ -7,6 +7,13 @@ Development Lead
 
 * Holger Frey <frey@imtek.de>
 
+
+Original PHP Version
+--------------------
+
+* Sebastian Sebald (@sebald on github)
+
+
 Contributors
 ------------
 
diff --git a/HISTORY.rst b/HISTORY.rst
index 5c9467a..985b73d 100644
--- a/HISTORY.rst
+++ b/HISTORY.rst
@@ -2,7 +2,13 @@
 History
 =======
 
+0.1.0 (2017-10-05, branch php2python)
+-------------------------------------
+
+* first working version of the PHP to Python rewrite
+
+
 0.0.1 (2017-09-26)
 ------------------
 
-* First release on PyPI.
+* setup of the project
diff --git a/README.rst b/README.rst
index 081c497..e865fac 100644
--- a/README.rst
+++ b/README.rst
@@ -1,10 +1,43 @@
-===========================
-Ordr2 - CPI Ordering System
-===========================
+==============================================
+Ordr2 - CPI Ordering System, php2python branch
+==============================================
 
+This is a rewrite in Python of the original Ordr system by Sebastian Sebald
+that can still be found here: https://github.com/sebald/Ordr
 
-Features
+
+Installation
+------------
+
+Installation consists of three steps:
+
+1. clone the project and checkout the php2python branch
+    > git clone https://git.cpi.imtek.uni-freiburg.de/holgi/ordr2
+    > cd ordr2
+    > git checkout php2pyton
+
+2. create a python virtual environment and activate it
+    > python3 -m venv ordr-venv
+    > source ordr-venv/bin/activate
+
+3. install the cloned package and deactivate the environment
+    (ordr-venv) > pip install .
+    > deactivate
+
+
+Updating
 --------
 
-* TODO
+updating consists of three steps:
+
+1. Update the source code
+    > cd ordr2
+    > git pull origin php2python
+
+2. activate the python virtual environment
+    > source ordr-venv/bin/activate
+
+3. install the new version and deactivate the environment
+    (ordr-venv) > pip install .
+    > deactivate
 
diff --git a/setup.py b/setup.py
index cfe2d10..24d28f5 100644
--- a/setup.py
+++ b/setup.py
@@ -17,15 +17,15 @@ requirements = [
     'pyramid_debugtoolbar',
     'pyramid_tm',
     'pyramid_mailer',
-    'SQLAlchemy',
-    'transaction',
-    'zope.sqlalchemy',
-    'waitress',
     'bcrypt',
     'deform',
     'PyYAML',
+    'SQLAlchemy',
     'tqdm',
+    'transaction',
+    'waitress',
     'XlsxWriter',
+    'zope.sqlalchemy',
 ]
 
 setup_requirements = [
diff --git a/tests/test_ordr2.py b/tests/test_ordr2.py
deleted file mode 100644
index 547038d..0000000
--- a/tests/test_ordr2.py
+++ /dev/null
@@ -1,25 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-''' Tests for `ordr2` package. '''
-
-import pytest
-
-
-import ordr2
-
-
-@pytest.fixture
-def response():
-    ''' Sample pytest fixture.
-
-    See more at: http://doc.pytest.org/en/latest/fixture.html
-    '''
-    # import requests
-    # return requests.get('https://github.com/audreyr/cookiecutter-pypackage')
-
-
-def test_content(response):
-    ''' Sample pytest test function with the pytest fixture as an argument. '''
-    # from bs4 import BeautifulSoup
-    # assert 'GitHub' in BeautifulSoup(response.content).title.string