Skip to content

Commit d2745a7

Browse files
committed
update README
1 parent f43dcfe commit d2745a7

File tree

3 files changed

+40
-150
lines changed

3 files changed

+40
-150
lines changed

README.md

+13-68
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,27 @@
1-
# WebAI.js-Examples
2-
English | [中文版](./README_CN.md)
1+
# WebAI.js 示例
2+
中文版 | [English](./README_EN.md)
33

4-
## 1. Introduction
5-
* This repo contains several webai.js examples
4+
## 1. 介绍
5+
* 这个项目中包含了多个 WebAI.js 的示例
66

7-
|Type|Example|
7+
|类型|示例|
88
|:-:|:-:|
9-
|Face Detection|[ppdet](./ppdet)|
10-
|ImageNet Classification|[ppcls](./ppcls)|
11-
|Human Segmentation|[ppseg](./ppseg)|
9+
|快速开始|[quick_start](./quick_start)|
10+
|人脸识别|[ppdet](./ppdet)|
11+
|图像分类|[ppcls](./ppcls)|
12+
|人体分割|[ppseg](./ppseg)|
1213

13-
## 2. Usage
14-
* Clone this repo:
14+
## 2. 使用
15+
* 克隆项目:
1516

1617
```bash
1718
$ git clone https://github.com/AgentMaker/WebAI.js-Examples
1819
```
1920

20-
* Switch to the directory for the example, like './ppdet':
21+
* 切换至示例目录,比如 './ppdet'
2122

2223
```
2324
$ cd ./ppdet
2425
```
2526

26-
* Edit the model path in the code:
27-
28-
```js
29-
// main.js
30-
// It is recommended that models and configuration files be placed in the 'public' directory, where files can be referenced using the path '/*'
31-
32-
...
33-
const modelURL = [PATH TO MODEL]
34-
const modelConfig = [PATH TO CONFIG]
35-
...
36-
```
37-
38-
* Install dependencies:
39-
40-
```bash
41-
$ npm install
42-
```
43-
44-
* Develop the web page:
45-
46-
```bash
47-
$ npm run dev
48-
49-
# Through the browser to http://localhost:3000 to check and test page
50-
```
51-
52-
* Build the web page:
53-
54-
```bash
55-
$ npm run build
56-
```
57-
58-
* Preview the built web page:
59-
60-
```bash
61-
$ npm run preview
62-
63-
# Through the browser to http://localhost:5000 to preview the built page
64-
```
65-
66-
* Build the web page to the '../docs' directory:
67-
68-
```bash
69-
$ npm run build:docs
70-
```
71-
72-
* Deploy the web page to the Github/Gitee Page:
73-
74-
1. fork the repo
75-
76-
2. Complete web page development
77-
78-
3. Build the web page to the '../docs' directory
79-
80-
4. Enable the repo Page function
81-
82-
5. set 'docs' as the source of the Page function
27+
* 更多细节请参考示例目录内的文档

README_CN.md

-82
This file was deleted.

README_EN.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# WebAI.js-Examples
2+
[中文版](./README.md) | English
3+
4+
## 1. Introduction
5+
* This repo contains several webai.js examples
6+
7+
|Type|Example|
8+
|:-:|:-:|
9+
|Quick Start|[quick_start](./quick_start)|
10+
|Face Detection|[ppdet](./ppdet)|
11+
|ImageNet Classification|[ppcls](./ppcls)|
12+
|Human Segmentation|[ppseg](./ppseg)|
13+
14+
## 2. Usage
15+
* Clone this repo:
16+
17+
```bash
18+
$ git clone https://github.com/AgentMaker/WebAI.js-Examples
19+
```
20+
21+
* Switch to the directory for the example, like './ppdet':
22+
23+
```
24+
$ cd ./ppdet
25+
```
26+
27+
* Refer to the documentation in the example directory for more details

0 commit comments

Comments
 (0)