Skip to content

Commit

Permalink
docs: 修改 README 文档
Browse files Browse the repository at this point in the history
  • Loading branch information
wangrongding committed Sep 15, 2022
1 parent 8bf8c9b commit ee06de8
Showing 1 changed file with 54 additions and 52 deletions.
106 changes: 54 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,63 +9,26 @@
style="width:400px"
/>

## 开发

### 安装依赖

```sh
yarn
```

## 需要注意的是

由于该仓库有一些依赖包,依赖了二进制文件

如果遇到 `node-pre-gyp ERR! ` `gyp ERR!`等问题,按照下面的方法解决

```sh

# 在node-gyp之前安装 (windows用户在powershell(管理员身份)中安装)
npm install -g --production windows-build-tools

# 全局安装node-gyp
npm install -g node-gyp
```

如果仍然不行,检查本地是否安装了 Python,没有则安装 👉 [官方地址](https://www.python.org/downloads/)

## 本地运行

```sh
yarn dev
```

## 打包

```sh
yarn build
```

## 格式化代码并执行 eslint 校验

```sh
yarn fal
```

## 我的博客

所有示例的具体实现和技术说明,在我的博客中都有对应的文章
所有示例的具体实现和技术说明,[我的博客](https://www.fedtop.com/)中都有对应的文章

<img
<!-- <img
src="https://assets.fedtop.com/picbed/20220531142049.png"
alt=""
style="width:400px"
/>

[博客地址](https://www.fedtop.com/)
/> -->

## 包含项目

### WebRTC 音视频协同

- 拍照 ![](https://assets.fedtop.com/picbed/202209150918746.png)

- 无信令传递 sdp(p2p 音视频通话)

![](https://assets.fedtop.com/picbed/202209150922457.png)

### ThreeJs

<img
Expand Down Expand Up @@ -102,13 +65,13 @@ yarn fal
### 千图成像

<img
src="https://files.mdnice.com/user/17056/d6c67ad8-64c5-46b9-a966-e259550e18a9.gif"
src="https://assets.fedtop.com/picbed/202209150916358.gif"
alt=""
style="width:400px"
/>

<img
src="https://files.mdnice.com/user/17056/9617bf11-1dd9-47b0-b4e9-41db87866f77.gif"
src="https://assets.fedtop.com/picbed/202209150917662.gif"
alt=""
style="width:400px"
/>
Expand All @@ -127,6 +90,45 @@ yarn fal

该示例正在捣鼓中...

### WebRTC 音视频协同
## 开发

该示例正在捣鼓中...
### 安装依赖

```sh
yarn
```

## 需要注意的是

由于该仓库有一些依赖包,依赖了二进制文件

如果遇到 `node-pre-gyp ERR! ` `gyp ERR!`等问题,按照下面的方法解决

```sh

# 在node-gyp之前安装 (windows用户在powershell(管理员身份)中安装)
npm install -g --production windows-build-tools

# 全局安装node-gyp
npm install -g node-gyp
```

如果仍然不行,检查本地是否安装了 Python,没有则安装 👉 [官方地址](https://www.python.org/downloads/)

## 本地运行

```sh
yarn dev
```

## 打包

```sh
yarn build
```

## 格式化代码并执行 eslint 校验

```sh
yarn fal
```

1 comment on commit ee06de8

@vercel
Copy link

@vercel vercel bot commented on ee06de8 Sep 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.