From 1c675338c6b684207bc4efde13f4599de408a988 Mon Sep 17 00:00:00 2001 From: Andrew Williams Date: Sun, 20 May 2012 17:35:21 +0100 Subject: [PATCH] Updated README --- README => README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) rename README => README.md (56%) diff --git a/README b/README.md similarity index 56% rename from README rename to README.md index 75b7ba9..189d899 100644 --- a/README +++ b/README.md @@ -1,4 +1,12 @@ -REQUIREMENTS +TEST Auth +========= + +TEST Auth is a central access management system for EVE Online corporations and alliances, it stores and manages EVE API keys and assigns access permissions based on defined permissions. + +Included is a HR management system, a group management system and a basic API key viewer showing Character and skill information. + + +Requirements ------------ The requirements.txt covers all dependencies for Auth, setup a virtual env and install the requirements: @@ -9,8 +17,10 @@ pip install -r requirements.txt As we're using system wide packages, its advisable to install python-mysql packages system wide, otherwise you'll need a basic build env on your machine (build-essentials, python-dev on Debian). -RUNNING +Running ------- For dev, use ./manage.py runserver :, after loading the virtualenv. In development Celery will operate in-process and doesn't require a seperate celeryd process to execute. +For Live instances its advisable to run within a WSGI container server such as uWSGI. +