Permalink
Browse files

fix: readme

  • Loading branch information...
whizbz11 committed Jan 4, 2017
1 parent 2fabe31 commit e09b28ad16c9f50819f0a936b444fe76d680dced
Showing with 31 additions and 38 deletions.
  1. +29 −36 README.md
  2. +2 −2 README_CN.md
@@ -7,52 +7,46 @@
[![NPM downloads](http://img.shields.io/npm/dm/tinper-neoui.svg?style=flat)](https://npmjs.org/package/tinper-neoui)
[English Document](./README.md)
## 介绍
[tinper neoui](http://tinper.org/dist/neoui/index.html) 是基于 UI 设计语言 iuap design 实现的企业级前端UI框架,帮助用户快速构建标准一致的前端页面,提高开发效率。
[中文文档](./README_CN.md)
## Introduction
[tinper neoui](http://tinper.org/dist/neoui/index.html) is based on the UI design language IUAP design to achieve the enterprise-class front-end framework. It can help users to quickly build a standard consistent front page and improve the development efficiency
## 功能
## Features
### 丰富的组件
neoui 包含丰富的 CSS 组件、JS 插件
* Rich components
### 按需定制
* Download resources according to your needs
可以轻松定制所需模块 减小文件尺寸 提升效率,节约资源
* Responsive layout
### 响应式布局
* Adapter mainstream browser (IE8+ 、firefox、Chrome、Safari)
基于12栅格系统 全面兼容不同浏览器及设备 一次开发,多端兼容
### 浏览器兼容性
## Quickstart
支持IE8+ 、firefox、Chrome、Safari等主流浏览器,轻松帮您解决浏览器兼容问题
### Install
## 快速上手
### 获取neoui
- 直接从github获取我们的源码
- From github
```
git clone git@github.com:iuap-design/tinper-neoui.git
```
- 使用CDN
- CDN
```
http://design.yyuap.com/static/uui/latest/js/u.js
http://design.yyuap.com/static/uui/latest/css/u.css
```
- 使用npm安装
- npm
```
npm install tinper-neoui
```
### 快速创建一个页面
### Use
```
<!DOCTYPE html>
@@ -77,7 +71,7 @@ npm install tinper-neoui
<body>
<h1> Hi, tinper neoui </h1>
<!-- 你的代码 -->
<!-- your code -->
<script src="//design.yyuap.com/static/jquery/jquery-1.11.2.js"></script>
@@ -91,49 +85,48 @@ npm install tinper-neoui
</body>
</html>
```
## 文档
## Document
开发文档详见[这里](http://tinper.org/dist/neoui/global/README.html)。
[Develop documentation](http://tinper.org/dist/neoui/global/README.html)。
更多内容请移步我们的[官网](http://tinper.org)
[Website](http://tinper.org)
## 如何参与贡献
## Contributing
### 反馈
如在使用过程中遇到任何问题,可以在[这里](https://github.com/iuap-design/tinper-neoui/issues)提交issue反馈;
### Feedback
或者直接fork代码到你的github仓库,提交pull request给我们
If you encounter any problems ,submit [issues](https://github.com/iuap-design/tinper-neoui/issues),or pull request
[PR code](CONTRIBUTING.md)
[Bug 反馈及需求提交](CONTRIBUTING.md)
### Develop
### 开发及构建
Developers can participate in the development of neoui, but also can be based on neoui two development
开发者可以一起参与为 neoui 贡献代码,同时也可以基于 neoui 进行二次开发或封装插件。
tinper-neoui use gulp.js and webpack build the project.
neoui 使用 [gulp.js](http://gulpjs.com/) 构建项目。
克隆项目文件:
clone:
```
$ git clone git@github.com:iuap-design/tinper-neoui.git
```
然后进入目录安装依赖
install
```
$ npm install
```
接下来,执行 `gulp`
build
```
$ npm run product
```
### 官方QQ群
### Website Chat Group
527124070
@@ -117,7 +117,7 @@ npm install tinper-neoui
开发者可以一起参与为 neoui 贡献代码,同时也可以基于 neoui 进行二次开发或封装插件。
neoui 使用 [gulp.js](http://gulpjs.com/) 构建项目。
neoui 使用 [gulp.js](http://gulpjs.com/) 和 [webpack](https://webpack.github.io/)构建项目。
克隆项目文件:
@@ -131,7 +131,7 @@ $ git clone git@github.com:iuap-design/tinper-neoui.git
$ npm install
```
接下来,执行 `gulp`
接下来,编译
```
$ npm run product

0 comments on commit e09b28a

Please sign in to comment.