nikdoof/django-evesde
1
0
Fork 0
mirror of https://github.com/nikdoof/django-evesde.git synced 2025-12-13 02:42:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Andrew Williams
2013-11-11 14:55:57 +00:00
parent 04d35361ba
commit 0ff053c2b4
1 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -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``.