-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #7 from ryuujo1573/doc
✈️ Accomplish readme
- Loading branch information
Showing
1 changed file
with
30 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,31 @@ | ||
# untitled-whiteboard | ||
<h1 align="center">untitled-whiteboard</h1> | ||
|
||
An untitled whiteboard app runs on Web. | ||
|
||
## 运行 | ||
|
||
如果没有安装 `pnpm`,请先安装 `pnpm` | ||
|
||
```shell | ||
npm i -g pnpm | ||
``` | ||
|
||
安装依赖 | ||
|
||
```shell | ||
pnpm i | ||
``` | ||
|
||
运行 development 环境 | ||
|
||
```shell | ||
pnpm dev | ||
``` | ||
|
||
## 架构设计文档 | ||
|
||
[架构设计文档 · ryuujo1573/untitled-whiteboard Wiki (github.com)](https://github.com/ryuujo1573/untitled-whiteboard/wiki/%E6%9E%B6%E6%9E%84%E8%AE%BE%E8%AE%A1%E6%96%87%E6%A1%A3) | ||
|
||
## 演示视频 | ||
|
||
[stem cell队|七牛云1024创作节参赛作品_哔哩哔哩_bilibili](https://www.bilibili.com/video/BV1Nd4y1k7WL) |