diff --git a/docs/cn/README.md b/docs/cn/README.md index eaf14f7..9cdf52a 100644 --- a/docs/cn/README.md +++ b/docs/cn/README.md @@ -8,6 +8,7 @@ * 简单的开发方式,开发者以编写[json数据文件](descjson.md)的形式开发前端应用 ## [bricks简介](brief.md) ## [bricks安装](install.md) +## [bricks开发](develop.md) ## [控件介绍](widgets.md) ## [控件描述文件](descjson.md) ## [事件处理](event.md) diff --git a/docs/cn/develop.md b/docs/cn/develop.md new file mode 100644 index 0000000..eeabf2c --- /dev/null +++ b/docs/cn/develop.md @@ -0,0 +1,34 @@ +# bricks开发和测试 + +## 环境准备 + +### 后台服务器安装部署 +与bricks框架同时开发的[gadget](https://git.kaiyuancloud.cn/yumoqing/gadget)的后台服务器,是一个python开发的后台应用服务器。 + +请按照gadget服务器的安装说明部署后台应用服务器 + + +或者部署其他后台服务器,后台服务器需满足[对后台服务器要求](server.md) + +### 将bricks的目标文件复制或链接到后台服务器的web文档根目录下 + +### index.html + +请参照/bricks/header.tmpl和/bricks/footer.tmpl内容,编写项目的index.html文件 + +将项目的root控件放在index.html中, + +其中,可以添加项目自身的css文件,项目自己的javascript + +可设置的内容请参看[index.html文件内容](index_html.md) + +### 用户界面编写 + +以".ui"后缀的文件命名编写控件描述文件。文件内容请参看[控件描述文件](descjson.md) + +并保存在后台服务器的web文件目录下 + +### 界面调试 +用控件文件的url直接调试界面 + + diff --git a/docs/cn/index_html.md b/docs/cn/index_html.md new file mode 100644 index 0000000..65ccbe1 --- /dev/null +++ b/docs/cn/index_html.md @@ -0,0 +1,66 @@ +# index.html文件内容 + +一个例子 +``` + + + + + + + + + + + + + + + + + + + + + + + + + + +``` +说明 + diff --git a/docs/cn/install.md b/docs/cn/install.md index 6b10198..05a30b5 100644 --- a/docs/cn/install.md +++ b/docs/cn/install.md @@ -1,3 +1,37 @@ # 安装bricks +## 下载bricks +执行以下命令 +``` +git clone https://git.kaiyauncloud.cn/yumoqing/bricks +``` +执行完成后bricks的源码存放在bricks目录中 + +## 构建和安装 +执行以下命令 +``` +cd bricks +cd bricks +./build.sh +cd .. +ln -s `pwd`/dist $(web根目录}/bricks +``` +命令执行完成后,构建完成的目标文件在bricks/dist目录中 + +并将bricks/dist目录复制或链接到web服务器的根文件目录中 + +## 依赖 +bricks框架目前引用如下软件包 + +* marked.min.js Markdown解析和展示包 + +* recorder.wav.min.js 跨平台的录音软件包 + +* video.min.js 跨平台的视频播放软件包 + +* videojs-ie8.min.js video视频播放器ie8兼容包 + +* xterm.js web终端软件包 + +bricks把依赖的第三方软件包放在/bricks/3parties目录下