/gamelocker-vainglory

Vainglory Game Data Service

Primary LanguageJavaScriptOtherNOASSERTION

Vainglory Game Data Server Documentation

Prerequisites

You're going to need:

  • Linux or OS X — Windows may work, but is unsupported.
  • Ruby, version 2.2.5 or newer or Docker
  • Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

Getting Set Up

  1. Fork this repository on Github.
  2. Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/gamelocker-vainglory-docs.git
  3. cd gamelocker-vainglory-docs
  4. Initialize and start. You can either do this locally, or with Vagrant:
# either run this to run locally
bundle install
bundle exec middleman server

You can now see the docs at http://localhost:4567. Whoa! That was fast!

Now that you're all set up, you'll probably want to learn more about editing Slate markdown, or how to publish your docs.

If you'd prefer to use Docker, instructions are available in the wiki.

Special Thanks