Giter Club home page Giter Club logo

eveonline-third-party-documentation's Introduction

Documentation Status

eveonline-third-party-documentation

Documentation for EVE Online third-party developers. This covers things like the XML API, CREST, the Static Data Export (SDE), and SSO. You can read the latest version of the documentation here. Read the instructions below if you'd like to contribute.

Developing

Setup

You will need to have python, pip and virtualenv installed (install virtualenv using pip) then run the following commands from inside the repo directory:

Windows

virtualenv venv
venv\Scripts\activate
pip install -r requirements.txt

Linux/mac

virtualenv venv
source venv/bin/activate
pip install -r requirements.txt

Running

make livehtml

Contributing

Please organize your submissions by API "section" and submit a separate pull request for each change. We suggest you create a separate branch for each pull request. This will make it easier to work on multiple changes simultaneously.

For example, to contribute a change to the XML API docs for character MarketOrders:

  1. Create a branch (say, "marketorders") on your fork of ccpgames/eveonline-third-party-documentation
  2. In your branch, make your changes to docs/xmlapi/character/char_marketorders.md. Be sure to follow the standards for each section of the documentation.
  3. Submit a pull request from yourfork:marketorders to ccpgames:master

Please also add your name to the CONTRIBUTORS file (sorted by first name please!).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.