From 0ff053c2b4c3ad3de9fc861acfce90b52d7a1dff Mon Sep 17 00:00:00 2001 From: Andrew Williams Date: Mon, 11 Nov 2013 14:55:57 +0000 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 3c95c17..dcc6126 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,28 @@ django-evesde ============= A Django app abstracting out the EVE Online Static Data Extract into a usable format. + +Inspired by @gtaylor's ``django-eve-db``, the idea is to a useful Django application for the EVE SDE data, with some extra tools for common operations on the SDE. + + +License +======= + +This code is licensed under the BSD 3-clause License, for further details refer to the ``LICENSE`` file + + +Installation +============ + +Install by running ``python setup.py install`` either within your virtualenv or as root for a system-wide installation. + + +Usage / Documentation +===================== + +This project generates its documentation via ``Sphinx``, to create the documentation run ``make html`` in the ``docs`` directory. + +Testing +======= + +Our aim is to have the project as testable as possible. Our tests are ran via standard Django tests, which can be run from the ``example_project`` folder by using ``python manage.py test``.