Document and version racontest

lib/racontest.js

@@ -1,3 +1,41 @@
+/*
+racontest.js
+
+Copyright (c) 2015 Bruno Dias
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+*/
+
+/* Testing Utilities
+
+Creates an interface for testing/debugging the game. Usage:
+
+  var racontest = require('raconteur/lib/racontest.js');
+
+  // Inside undum.game.init
+
+  racontest.init(system);
+
+racontest.init does nothing unless location.hash is "#debug", so to access it
+you should point your browser at [address, most likely localhost]#debug. Those
+two lines can then safely be removed from the source to bundle a smaller
+distribution for players.
+
+Currently, the only implemented feature is the ability to hop to an arbitrary
+situation by inputting its (internal) name. Due to Undum's own architecture,
+trying to hop to the wrong situation will cause an (unrecoverable) error.
+*/
+
+'use strict';
+
 var $ = require('jquery');
 
 var RACONTEST_TEMPLATE = `