README

你只想使用scandiojs

Scandiojs 已注册为 bower 组件。在一个有 bower 设置的项目中，运行 bower install scandiojs --save 将安装 scandiojs 并将其作为依赖项添加到项目的 bower.json 中。

对于没有 bower 的项目，只需导航到 dist 目录，选择最新的 开发 或 生产 版本。如果你使用的是较新的浏览器并且熟悉源映射，你也可以选择获取 源映射 文件。

带注释的源代码可以在 GitHub 页面 上找到，并从 gh-pages 分支提供服务。

注意：如果你打算使用 DOM-Logging 功能，你也应该选择获取 css 文件 来获取一些样式。

深入了解scandiojs

在克隆 scandiojs 后，你可以通过查看 /example 目录来检查一些示例。`index.html` 展示并执行了 index.js 中的每个函数调用，目前它几乎涵盖了 scandiojs 中可用的所有函数。

此外，你可以检查 /docs 目录中存在的 带注释的源代码。这是在构建过程中（Gruntfile.js）通过 Docco 自动生成的。

最后，如果你想检查文档化源代码的最新版本，只需查看 scandio.js 文件。

扩展scandiojs

你可以使用 ß.util.mixin-fn 轻松扩展 scandiojs 以满足你自己的需求。`test/featurerequest/src/template.js` 包含了一个示例。测试你的代码也很容易，并且已经设置好了。只需查看 test/featurerequest/test/template.js。

有关更多信息，请参阅 CONTRIBUTING.md。

构建scandiojs所需的工具

为了构建 scandiojs，你需要有 Node.js (~0.10.x)、npm (~1.3.x) 和 git ~1.7。早期版本可能也可以正常工作，但未经过测试，而且谁愿意活在过去呢。

对于 Windows，你必须下载并安装 git 和 Node.js。

Mac OS 用户只需安装 Homebrew。一旦安装了 Homebrew，运行 brew install git 安装 git，运行 brew install node 安装 Node.js，运行 brew install npm 安装 npm。

Linux/BSD 用户应使用适当的包管理器安装 git 和 Node.js，或者如果你愿意，也可以从源代码构建。很简单。

构建你自己的scandiojs版本

首先，通过运行以下命令克隆主 scandiojs git 仓库：

git clone git://github.com/scandio/scandiojs.git

如果您之前没有安装，请安装 grunt-cli 和 bower 包。这些包应该作为全局安装进行。

npm install -g grunt-cli bower

进入 scandiojs 目录，并安装 Node.js 和 Bower 依赖，这次 不要 指定全局选项（-g）安装。

cd scandiojs && npm install

然后，为了获取完整、压缩（使用 Uglify.js）、格式化（使用 JSHint）的 scandiojs 版本，请输入以下内容：

注意： 所有构建版本都始终存在于 dist 文件夹中。在构建自己的版本之前，您可能还需要在 package.json 中增加版本号，以避免覆盖之前的版本。

grunt dist

如前所述，scandiojs 的构建版本将被编译到 dist/ 子目录中，包括压缩副本和相关的源映射文件。

测试您的更改或构建

您还可以参考 CONTRIBUTING.md 获取更详细的信息，这对您添加功能请求并测试代码后非常有用。

为了测试您的构建或所做的任何更改，您应该运行以下命令：

cd scandiojs

您应该使用 testem 测试您的代码：如果 testem 没有安装，请输入 npm install testem -g

grunt test-em

这将启动一个运行在 Safari、Chrome 和 Firefox 中的 testem 服务器。

您还可以手动启动 testem 并通过导航到 testem-runner 提供的 URL 运行测试套件。