diff options
| author | Alex Xu <alex_y_xu@yahoo.ca> | 2014-01-24 18:32:18 -0500 |
|---|---|---|
| committer | Alex Xu <alex_y_xu@yahoo.ca> | 2014-01-24 18:32:18 -0500 |
| commit | 50ea5fe47d68983f304ac1524d1f88f3944f67ec (patch) | |
| tree | b9fcc3d97f79a039bc4efc5943bed1224993beba | |
| parent | 3a367a00e45880de6b5472c07ce65043ab83eae7 (diff) | |
| download | html5ks-50ea5fe47d68983f304ac1524d1f88f3944f67ec.tar.xz html5ks-50ea5fe47d68983f304ac1524d1f88f3944f67ec.zip | |
add basic docs
| -rw-r--r-- | README | 2 | ||||
| -rw-r--r-- | docs/architecture.txt | 16 |
2 files changed, 18 insertions, 0 deletions
@@ -47,6 +47,8 @@ Run `make space`. Warning: This will remove source files from dump. Check Bugzilla for things that need to be done. [3] +See docs/ for the obvious. + [0] http://www.katawa-shoujo.com/ [1] https://github.com/cujojs/when/ [2] If you're on Windoze, sucks for you. Use a better OS. diff --git a/docs/architecture.txt b/docs/architecture.txt new file mode 100644 index 0000000..d6f7612 --- /dev/null +++ b/docs/architecture.txt @@ -0,0 +1,16 @@ +This is an overview of the layout of the code. + +unrpyc/ decompiles rpyc from the distribution to JSON so that it can be parsed +with JSON.parse. + +js/html5ks.js is the main entry point; this initializes the code then calls +the init function in the submodules. It also manages transforms to fit the +container to the window. + +js/imachine.js interprets instructions from imachine.json to jump to scenes, +play videos, select branches as appropriate based on choices. + +js/api.js effectively runs script.json, dispatching commands to functions +which operate on the DOM. + +js/menu.js manages the main menu, context menu, and options menu. |