Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 1.08 KB

DEVELOPER.md

File metadata and controls

25 lines (16 loc) · 1.08 KB
Raw

Developer guide

Requirements: node

Setup

npm install
./node_modules/.bin/gitbook install

Take a look at scripts section in package.json for development commands.

Tech

  • CLI: commander, exported as a binary
  • Doc: gitbook, asciidoc, hosted on github

Quests

Hosted as git repository named git-quest-src.

Each quest starts with a branch and may ends with a tag when necessary. For instance, the first quest works with quest/1 branch and quest/1--end tag. The extra setup is defined in src/quests/quest1.js and executed with git-quest init 1 CLI command.

A simple project to start with is available on dev branch.

Quest instructions and help are hosted in the documentation (see doc/quests/quest1). The player is redirected to it with git-quest read and git-quest help commands.