<commit_before># Squirrle 3

## 一、简介

Squirrle 是一款基于 HTML5 的轻量级移动前端框架，能够简单、迅速的开发跨平台的移动 Web 应用。

## 二、特性

* 基于 HTML5，应用了 HTML5 的多种特性，如 CSS3、离线应用、本地存储等。
* 多操作系统支持，支持 iOS、Android、Firefox OS 等操作系统，可以根据需要扩展支持更多系统，如：Windows Phone、黑莓等。
* 为移动设备打造，专为手持移动设备打造的框架，能适应不同屏幕尺寸，针对不同尺寸屏幕做了排版优化。
* 提供丰富的 UI 组件和交互插件，可以极大简化 Web 应用开发工作量。
* 可定制，提供定制工具，可以根据实际需要灵活的定制内容，按需最小化加载组件及插件。
* 为 UC 浏览器优化。

## 三、使用指南

### 1、安装

Squirrel 支持两种安装方式：

1. 下载 Squirrle 3 开发包，开发包分为『正式版』和『开发版』；『正式版』里面包含已经编译好的 CSS、Javascript 文件和图片文件；『开发版』则额外包含文档和源码，目录结构：

		Squirrel/
  		├── css/
  		│   ├── squirrel.css
  		│   ├── squirrel.min.css
  		├── js/
  		│   ├── squirrel.js
  		│   ├── squirrel.min.js
  		└── images/
    	│   ├── sq-icon@2x.png
    	└── index.html

2. 使用 NPM 安装 Squirrle 3 工程套件  
	完整的 Squirrle 3 工程套件包括框架代码、单元测试和自动化构建工具，是一套完整的前端开发、测试、发布解决方案（工程套件需要 NodeJS、npm 和 Grunt 支持，请自行配置），套件目录结构：


		Squirrel-pt/
  		├── app/ (应用目录)
  		│   ├── dist/ (构建代码)
  		│   │   ├── css/
  		│   │   ├── js/
		│   │   ├── images/	
  		│   ├── src/ (源码)
  		│   │   ├── less/
  		│   │   ├── js/
  		│   ├── index.html
  		├── libs/ (第三方 JS 类库)
  		│   ├── zepto/
  		│   │   ├── zepto-1.0.min.js
  		├── test/ (单元测试)
  		├── tools/ (自动化构建工具)
  		│   ├── grunt/
    	└── index.html

	
	可以手动下载 Squirrle 3 工程套件包 Project-Template（15MB），或者通过 npm 命令安装：
	
		npm install squirrel-pt
	
	下载完成后需要对 package.json 进行配置。

### 2、使用

Squirrel 集成了许多常用的组件及插件，只需要简单的几步就可以快速的使用集成的组件及插件构建一个应用：

1. 打开并编辑安装目录中 index.html 文件；
2. 在框架文档中拷贝所需组件代码片段或者插件的实例化方法；
3. 加入自定义样式和 Javascript 脚本。

## 三、贡献力量

Squirrel 3 是遵循 MIT 协议的开源项目，代码寄托于 GitHub，如果感兴趣请加入我们贡献您的力量，您可以：

1. 希望您能反馈任何有关体验方面的意见和建议至 github issues「体验」，您可以提出问题或改进建议，甚至提出新的功能需求。
2. 如果使用中发现 BUG，请提交至 github issues「BUG」，同时也请报告您的使用版本、环境，我们会尽快确认、修复。
3. 欢迎您为 Squirrel 贡献高实用性的功能插件，以方便其他使用者。开始之前请先阅读插件开发流程。
4. 如果您制作了一款基于 Squirrel 的主题并且符合主题的开发规范，我们非常欢迎您将它提交至主题库。
5. DPL 组件与业务结合紧密，具备高质量且完整的交互体验，如果您为您的项目开发了类似的组件，欢迎提交至设计模式库。


## 四、基于 Squirrle 3 构建的网站

* 国内 Android 应用商店抢先版
* 主题站
* 国际应用商店
<commit_msg>修改说明文档<commit_after># Squirrle 3

## 一、简介

Squirrle 是一款基于 HTML5 的轻量级移动前端框架，能够简单、迅速的开发跨平台的移动 Web 应用。

## 二、特性

* 基于 HTML5，应用了 HTML5 的多种特性，如 CSS3、离线应用、本地存储等。
* 多操作系统支持，支持 iOS、Android、Firefox OS 等操作系统，可以根据需要扩展支持更多系统，如：Windows Phone、黑莓等。
* 为移动设备打造，专为手持移动设备打造的框架，能适应不同屏幕尺寸，针对不同尺寸屏幕做了排版优化。
* 提供丰富的 UI 组件和交互插件，可以极大简化 Web 应用开发工作量。
* 可定制，提供定制工具，可以根据实际需要灵活的定制内容，按需最小化加载组件及插件。
* 为 UC 浏览器优化。

## 三、使用指南

### 1、安装

Squirrel 支持两种安装方式：

1. 下载 Squirrle 3 开发包，开发包分为『正式版』和『开发版』；『正式版』里面包含已经编译好的 CSS、Javascript 文件和图片文件；『开发版』则额外包含文档和源码，目录结构：

		Squirrel/
  		├── css/
  		│   ├── squirrel.css
  		│   ├── squirrel.min.css
  		├── js/
  		│   ├── squirrel.js
  		│   ├── squirrel.min.js
  		└── images/
    	│   ├── sq-icon@2x.png
    	└── index.html

2. 使用 NPM 安装 Squirrle 3 工程套件  
	完整的 Squirrle 3 工程套件包括框架代码、单元测试和自动化构建工具，是一套完整的前端开发、测试、发布解决方案（工程套件需要 NodeJS、npm 和 Grunt 支持，请自行配置），套件目录结构：


		Squirrel-pt/
  		├── app/ (应用目录)
  		│   ├── dist/ (构建代码)
  		│   │   ├── css/
  		│   │   ├── js/
		│   │   ├── images/	
  		│   ├── src/ (源码)
  		│   │   ├── less/
  		│   │   ├── js/
  		│   ├── index.html
  		├── libs/ (第三方 JS 类库)
  		│   ├── zepto/
  		│   │   ├── zepto-1.0.min.js
  		├── test/ (单元测试)
  		├── tools/ (自动化构建工具)
  		│   ├── grunt/
    	└── index.html

	
	可以手动下载 Squirrle 3 工程套件包 Project-Template（15MB），或者通过 npm 命令安装：
	
		npm install squirrel-pt
	
	下载完成后需要对 package.json 进行配置。

### 2、使用

Squirrel 集成了许多常用的组件及插件，只需要简单的几步就可以快速的使用集成的组件及插件构建一个应用：

1. 打开并编辑安装目录中 index.html 文件；
2. 在框架文档中拷贝所需组件代码片段或者插件的实例化方法；
3. 加入自定义样式和 Javascript 脚本。

## 三、贡献力量

Squirrel 3 是遵循 MIT 协议的开源项目，代码寄托于 [GitHub](https://github.com/iinterest/Squirrel-3)，如果感兴趣请加入我们贡献您的力量，您可以：

1. 希望您能反馈任何有关体验方面的意见和建议至 [Github issues](https://github.com/iinterest/Squirrel-3/issues)「体验」，您可以提出问题或改进建议，甚至提出新的功能需求。
2. 如果使用中发现 BUG，请提交至 [Github issues](https://github.com/iinterest/Squirrel-3/issues)「BUG」，同时也请报告您的使用版本、环境，我们会尽快确认、修复。
3. 欢迎您为 Squirrel 贡献高实用性的功能插件，以方便其他使用者。开始之前请先阅读插件开发流程。
4. 如果您制作了一款基于 Squirrel 的主题并且符合主题的开发规范，我们非常欢迎您将它提交至主题库。
5. DPL 组件与业务结合紧密，具备高质量且完整的交互体验，如果您为您的项目开发了类似的组件，欢迎提交至设计模式库。

{'fraction_non_alphanumeric': 0.14773293472845042, 'fraction_numerical': 0.014449427005480818, 'mean_word_length': 3.43646408839779, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 3, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1387002', 'n_tokens_mistral': 2981, 'n_tokens_neox': 3415, 'n_words': 393}