Modified build process. Updated documentation. Updated bower.json

Author: jabbany

.gitignore

@@ -4,4 +4,5 @@
 # or operating system, you probably want to add a global ignore instead:
 #   git config --global core.excludesfile ~/.gitignore_global
 #
+*.iml
 /node_modules/*

BUILDING.md

@@ -1,32 +1,50 @@
 Building 编译项目
 ==============================
+本项目采用 grunt 管理编译，有关 Grunt 系统的使用请参考[官方文档](http://gruntjs.com/getting-started)
+脚本弹幕部分的编译还需要 [TypeScript](http://www.typescriptlang.org/) 。这些库还会依赖于
+NodeJS环境。
 
-When building the comment core library, you can build two different types, 
-the minified or non minified.
+### 确定你是否需要编译 （Do I need to build CCL?）
+CommentCoreLibrary在库外提供了很多可扩展的空间，你可以相对简单的增加新的弹幕格式的支持，新的弹幕
+运行模式的支持和挂载各种不同的定时元件。CCL提供了丰富的扩展支持，通过预处理过滤器和运行时过滤器可以
+实现非常多的特殊功能支持。编译库意味着你可能需要一些默认环境没有的软件，比如 NodeJS 平台，为此需要
+付出一些架设精力。
 
-编译模块的时候，可以选择编译成两种不同的单文件。压缩版，和非压缩版。
+当然自己编译也会带来一些优势，比如更小的库大小和更加专注的功能支持。还有，希望帮助CCL实现更多支持的
+开发者们也需要知道如何有效的编译。
 
-The default is to build a minified version （我们默认会编译成压缩版，通过如下命令）:
+### 配置编译环境（Setup Build Environment）
+初次编译请确保你安装了 `node>=0.8.0`，为全局系统安装 grunt 请执行：
 
-    make
-    
-or
+    npm install -g grunt-cli
 
-    make all-uglify
+有些系统下可能需要管理员权限（如 `sudo`）。有关具体如何配置Grunt请参考官方文档。
 
-Minifying the JavaScript requires you to have Node.js installed. 压缩输出文件要求你
-有安装了Node.js。
+接下来你需要安装编译所需的库，可以简单的通过 `npm install` 进行安装。CommentCoreLibrary在
+运行时没有任何依赖关系，但是开发环境需要依赖 grunt 的一些部件和 TypeScript（参考下面“代码弹幕”
+章节）。
 
-If you want a non-minified single file version, use （下面的命令则会输出一个未经压缩的
-只有堆砌起来的文件）:
+### 编译（Building）
+编译项目请在根目录直接运行：
 
-    make all-concat-only
+    grunt
 
-Separate Components 分模块编译
------------------------------
-To build each module separately, run `make all`. It will produce 2 parts, parsers
-and the CommentCoreLibrary. 如果希望弹幕编译每个模块，运行上方命令，会产出两个部件，一个是CCL
-弹幕库，另一个是解析库。
+即可按照默认模板编译。除此之外，你还可以改变编译目标：
 
-You can also run `make extensions` to build all the experimental extensions. They
-will not be minimized. 你还可以编译正在实验中的一些扩展模块，这些模块不会被压缩以方便调试。
+- build ： 只编译项目，不会clean掉 build文件夹下的产物
+- build-core ： 只编译弹幕核心，不包括Acfun和Bilibili的解析器。这个更加适用各种二次开发不需要
+    已有的弹幕格式的
+
+默认模式会自动看管 `src` 源码文件夹，并且在产生变化的时候自动生成新版。
+
+### 调试（Debugging）
+本地调试的话，可以在本地架设Web Server。默认的 `demo` 文件夹下也有一套简易的调试界面。同时你还
+可以参考这个界面来实现你自己的嵌入调试。
+
+### 代码弹幕（Scripting Engine）
+默认的代码弹幕支持需要使用 TypeScript 编译。这需要你安装 TypeScript 支持，通过 
+`npm install -g typescript` 即可安装。代码弹幕部分临时还在使用旧的 `make` 系统，未来也会
+逐渐过渡到使用 Grunt。目前编译项目不会引入代码弹幕支持（考虑到架设难度的增高和潜在受众面相对于
+弹幕支持要少一些），相关库需要手动引入。
+
+参考 `docs/scripting` 了解代码弹幕系统和它的编译方法。

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+Contributing 做出贡献
+==================================
+CommentCoreLibrary欢迎广大开发者积极做出贡献，提交补丁和Bug信息。以下將介绍如何有效的提交贡献到
+CommentCoreLibrary上。
+
+CommentCoreLibrary welcomes all developers to contribute to the project in any 
+way, such as code, documentation or issue reports. This document describes how 
+you can effectively contribute to make our work easier.
+
+### 不具合报告（Bug Reports）
+CCL欢迎一切相关的缺陷报告，包括浏览器兼容性问题，代码报错，和显示偏差等等。请善用 Github 自建的
+[Issue Tracker](https://github.com/jabbany/CommentCoreLibrary/issues)。中文英文
+都可以。请在标题上尽可能清楚直观地描述问题，如：“弹幕3D效果投影距离与期待情况有偏差” 这样的标题。
+
+有关显示相关的问题，请最好附带上你的浏览器版本，操作系统/平台版本。欢迎截图，欢迎 console 
+错误信息复制粘贴。请确保你有标准中文字体（宋体 Simsun【必需】，黑体 Simhei【必需】，
+雅黑 Microsoft YaHei，幼圆 YouYuan，隶书），和日文字体（Mincho， Gothic）来达到最佳显示
+效果。
+
+Please use the issue tracker provided by Github to submit bug reports. These 
+include any compatibility problems, script generated errors, display problems
+etc. English or Chinese issue reports are both welcome and accepted. Descibe the 
+problem as clearly as possible in the title too. Also, for display and 
+compatibility problems please also include your browser vendor and OS info.
+
+PS: Just as heads up, check your font support first. Unix based systems often 
+choke on Chinese font names and render some fixed point animations wrong, this 
+may happen if you don't have fonts configured correctly. You should install the 
+basic Chinese font SimHei for accurate positioning of comments. 
+
+### 新功能讨论（Feature Request）
+新功能讨论，接口讨论，实验性分支（`dev-*`，`beta-*`分支树）的问题，也欢迎使用 Issue 报告。CCL
+是弹幕渲染层，有关视频格式，旧浏览器的向下兼容问题和各种平台上的挂载问题，可以在相应的
+ABPlayerHTML5 项目上报告
+
+You can also use the issue tracker to submit feature requests, implementation 
+discussions and development questions. Remember that CCL is just a comment 
+overlay, for problems concerning video, backwards compatability with pre-HTML5 
+and flash fallback, please report to ABPlayerHTML5 or other corresponding 
+projects.
+
+### 提交代码（Contributing Code）
+提交代码请使用 Github 自带的 Pull Request 功能。先把这个库 Fork 到你的账户，进行更改，之后
+选择好节点发送 Pull Request。注意：如果你的更改是对别的分支的更新，比如代码分支或者CSS动画分支，
+请提交到相应的分支下，而不是 `master`。
+
+Contributions of code or documentation are very welcome! You can use Github's 
+in-built Pull Request feature to submit a patch. Make sure the patch applies to
+the correct branch if you're not working on `master`. 

CommentCoreLibrary.iml

@@ -21,16 +21,25 @@ module.exports = (grunt) ->
     'src/parsers/AcfunFormat.js'
     'src/parsers/BilibiliFormat.js'
   ]
-
-  SRC_CORELIB = SRC_PARSER.concat(SRC_CORE)
+  
+  # Core concatenated with libraries
+  # Actual concat ordering does not/should not matter
+  SRC_CORELIB = SRC_CORE.concat(SRC_PARSER)
 
   grunt.initConfig(
+    clean:
+      build: ['build']
     # Concat CSS and JS files
+    # core_only : builds CCL without parsers
+    # all       : builds CCL with everything
     concat:
-      basic_and_extras:
+      core_only:
         files:
           'build/style.css': ['src/base.css', 'src/fontalias.css']
           'build/CommentCore.js':        SRC_CORE
+      all:
+        files:
+          'build/style.css': ['src/base.css', 'src/fontalias.css']
           'build/CommentCoreLibrary.js': SRC_CORELIB
 
     # Auto-prefix CSS properties using Can I Use?
@@ -50,23 +59,24 @@ module.exports = (grunt) ->
 
     uglify:
       options: banner: License
-      comment_core:
+      core_only:
         files:
           'build/CommentCore.min.js': SRC_CORE
-      comment_core_lib:
+      all:
         files:
           'build/CommentCoreLibrary.min.js': SRC_CORELIB
 
     # Watch files for changes
     watch:
-      css:
+      all:
         files: ['src/**/*', '!node_modules']
 
         # Run concat, autoprefixer, cssmin and uglify
         tasks: ['build']
   )
 
   # Register our tasks
-  grunt.registerTask 'build', ['concat', 'autoprefixer', 'cssmin', 'uglify']
-  grunt.registerTask 'default', ['build', 'watch']
+  grunt.registerTask 'build-core', ['concat:core_only', 'autoprefixer', 'cssmin', 'uglify:core_only']
+  grunt.registerTask 'build', ['concat:all', 'autoprefixer', 'cssmin', 'uglify:all']
+  grunt.registerTask 'default', ['clean', 'build', 'watch']
 

Gruntfile.coffee

@@ -1,77 +1,64 @@
-# Readme
-The CommentCoreLibrary is a set of Javascript 'classes' that make up the
-core controller for comments streaming on top of a video. It is intended
-as a catalyst for the future development of timed comments streaming 
-alongside videos. 
+# CommentCoreLibrary 弹幕核心通用构件
+The CommentCoreLibrary is a set of Javascript modules that make up the
+core controller for comments streaming on top of timed media (video or audio). 
+It is intended as a catalyst for the development of timed "danmaku" comments 
+in HTML5.
 
-The CCL is intended for education purposes (in contrast to 
-[ABPlayerHTML5](https://github.com/jabbany/ABPlayerHTML5)
-which focuses on real world use) and is separated into sections that 
-help developers understand how the library and how danmaku comments 
-work.
+Developers willing to incorporate similar comment streaming functionalities 
+inside their own projects (whether web based or not) are encouraged to learn 
+from and extend from the CommentCoreLibrary.
 
-Developers willing to incorporate similar comment streaming 
-functionalities inside their own projects (whether web based or not) are
-free to learn from and extend from the CommentCoreLibrary.
-
-## Testing on your browser
-You can see a live demo (most current source) 
-[here](http://jabbany.github.com/CommentCoreLibrary/demo). Feel free to open 
-tickets if this demo test has bugs. Remember to tell me your browser 
-vendor/version info though. PS, just a heads up, due to lack of
-fonts, Linux systems may render some fixed point animations wrong, this 
-is normal. You should install the basic chinese font SimHei for accurate
-positioning. 
+## Testing
+We have a live demo [here](http://jabbany.github.com/CommentCoreLibrary/demo). 
+Feel free to [open tickets](CONTRIBUTING.md) if this demo test has bugs. 
 
 ## License
-The CommentCoreLibrary is licensed under the permissive MIT License. If 
-you wish to use this in any project, you can simply include the 
-following line:
+The CommentCoreLibrary is licensed under the permissive MIT License. If you wish
+to use this in any project, you can simply include the following line:
+
+    CommentCoreLibrary (//github.com/jabbany/CommentCoreLibrary) - Licensed under the MIT license
 
-    CommentCoreLibrary (//github.com/jabbany/CommentCoreLibrary) - 
-    Licensed under the MIT license
- 
 ## Examples and Documentation
-- Documentation can be found inside the /docs/ folder. 
-- Some sample extension modules may be found in /extend/.
-- Experimental modules are in /experimental/.
-- You may test using test data found in /tests/.
+- Documentation can be found inside the `docs/` folder. 
+- Some sample extension modules may be found in `extend/`.
+- Experimental modules are in `experimental/`.
+- You may test using test data found in `tests/`.
 
 ## Contributing
-Please feel free to fork the project on GitHub. Also, bug reports and 
-feature requests are welcome!
+We encourage any contributions to this project, please read 
+[CONTRIBUTING](CONTRIBUTING.md) for details on how to contribute to the project.
+
+Also, feel free to have a look at our sister project 
+[ABPlayerHTML5](https://github.com/jabbany/ABPlayerHTML5) for a reference 
+implementation of a video player with CommentCoreLibrary.
 
 # 弹幕核心通用构件
-弹幕播放核心是一套原始的基于JavaScript构建的弹幕控制器，意在催化HTML5下弹幕播放器的
-发展，和为希望了解弹幕播放器弹幕组件运作原理的开发者提供简单但是深入的入门。该播放器核心
-由ABPlayerHTML5衍生，并现在被其使用。开发者们可以根据弹幕播放核心来自定义自己的流媒体
-注视播放模式。
+弹幕核心通用构件是一套基于JavaScript构建的弹幕控制器，意在催化HTML5下弹幕播放器的发展。同时方便
+希望了解弹幕播放器运作原理的开发者，提供简单但是深入的入门。开发者们可以根据弹幕核心通用构件来自定义
+自己的流媒体注释播放模式。
 
 不管你在开发基于Javascript的Web服务，还是其他的需要弹幕播放功能服务，都可以参考弹幕核心
 的实现代码。我们以简单的方法构建了 (1) 时间轴管理 (2) 基础空间规划 (3) 弹幕过滤 (4) 
-高级弹幕效果 (5) 基础格式解析
+高级弹幕效果 (5) 基础格式解析 (6) 代码弹幕支持
 
 ## 测试
 你可以在[这里](http://jabbany.github.com/CommentCoreLibrary/demo) 访问到测试页面。
-我们欢迎各种BUG提交。如果你在用Linux，请确保你有标准中文字体（宋体 Simsun【必需】
-，黑体 Simhei【必需】，雅黑 Microsoft YaHei，幼圆 YouYuan，隶书），和日文字体
-（Mincho， Gothic）。
+我们欢迎各种[BUG报告](CONTRIBUTING.md)。
 
 ## 许可
-本程序为教学用意，采取非常宽松的MIT许可。该许可允许你把本项目运用在任何开源或是闭源的，
-非营利或商业性的项目中。
+本项目采取非常宽松的MIT许可。该许可允许你把本项目运用在任何开源或是闭源的，非营利或商业性的项目中。
 您只需在使用到的地方添加下面一行注释：
 
-    CommentCoreLibrary (//github.com/jabbany/CommentCoreLibrary) - 
-    Licensed under the MIT license 
+    CommentCoreLibrary (//github.com/jabbany/CommentCoreLibrary) - Licensed under the MIT license
 
 ## 使用
-有关本项目的文档可以在 /docs/ 文件夹里面找到。一些功能性扩展模块会出现在 /extend/ 中。
-一些实验性模块在 /experimental/ 里面。
+- 有关本项目的文档可以在 `docs/` 文件夹里面找到。
+- 一些功能性扩展模块会出现在 `extend/` 中。
+- 一些实验性模块在 `experimental/` 里。
 
 ## 做出贡献
 非常欢迎提交问题报告和意见建议，同时你也可以在GitHub上Fork本工程，并发送Pull请求来提交
-你对项目的贡献。我们非常欢迎二次开发哟！
+你对项目的贡献。我们非常欢迎二次开发哟！有关具体介绍请参考 [CONTRIBUTING](CONTRIBUTING.md)。
 
-同时我们也欢迎对项目任何细节处的针对性研发，如解析功能，高级弹幕和CSS优化等。如果希望研发
-播放器的构造和功能，请参考 ABPlayerHTML5 项目～
+我们欢迎对项目任何细节处的针对性研发，尤其比如：解析功能、高级弹幕/代码弹幕和CSS优化等。
+如果希望研发播放器的构造和功能，请参考姊妹项目 ABPlayerHTML5。

README.md

@@ -1,6 +1,11 @@
 {
   "name":    "CommentCoreLibrary",
   "version": "0.9.0",
+  "ignore":  [
+  	"tests/**/*",
+  	"experimental/**/*",
+  	"demo/**/*"
+  ],
   "dependencies": {
   }
 }