Home

Here you'll find tutorials and guides.

Project Overview

Contents

• Getting started
• Tutorials
• Guidelines and conventions
• Links

Getting started

PLEASE READ: these steps are for people who want to help us create better data files. If you just want to use them, please visit BattleScribe Data on AppSpot.

Decide if you want to develop with us, or as a freelancer. To be a member or not to be

To help us develop datafiles:

0. Prerequisites:

   • GitHub account (personal and free) - register at https://github.com/join
   • Required lectures:
     • Membership Guidelines
     • Developer Guide (and optionally our nice Video Tutorial)

1. Prepare your workbench by installing newest versions of:

   • BattleScribe: http://www.battlescribe.net/
   • GitHub desktop app:
     • Windows: http://windows.github.com
     • Mac: http://mac.github.com

2. Log in to GitHub desktop app. You probably won't have any repositories listed - that's ok :)

3. The next steps depend on the repository:

   • The more active ones

     • wh40k
     • Horus Heresy

     often have a core team of maintainers that have write access (can actually modify the repo) - in that case you should fork the repository, make changes and submit them as Pull Request - this flow is described in detail at GitHub Help page.

   • For all the other repositories you should ask for write access and make changes directly. To do that, open a new issue in the appropriate repo - Choose where to contribute. Once you do that:

     • We'll invite you as a collaborator
     • You'll get an email with the invitation
     • Accepting the invitation will give you write access to the repository

Tutorials

• Video Tutorial
• Forking Guide
• Developer Guide

Guidelines and conventions

• Membership Guidelines
• Developer Guide
• Admin Guide
• Catalogue Naming Convention
• Simple: Issues
• General Catalogue writing guidelines

Links

• Project Overview
• BattleScribe homepage
• BattleScribe Data on AppSpot