Stubs for manuals: #52

doughsay · Jul 6, 2013 · a417cc6 · a417cc6
1 parent 61be8ec
commit a417cc6
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/players_manual.md b/players_manual.md
@@ -0,0 +1,11 @@
+Room.js Player's Manal
+======================
+
+This document should describe:
+
+* How to log in and create players
+* How to interact with the world
+* How the command parser works
+* How verbs are found and run
+
+It should not be specific to any database, but should include examples from the example database.
diff --git a/programmers_manual.md b/programmers_manual.md
@@ -0,0 +1,17 @@
+Room.js Programmer's Manual
+===========================
+
+This document should describe:
+
+* How to get to the editor
+* What you can and can't do from the editor and from the client
+* How the command parser works; in depth
+* How verbs are searched for; in depth
+* The context variables available to verb code
+* Finding objects
+* Built in attributes
+* Properties
+* Built in functions
+* Adding verbs
+
+It should not be specific to any database, but should include examples from the example database.