add readme

moonbitlang · Sep 18, 2024 · e21bd5f · e21bd5f
1 parent 14452be
commit e21bd5f
Show file tree

Hide file tree

Showing 7 changed files with 390 additions and 16 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,4 @@
 /dist
 node_modules
 meta.json
-data.json
 test.mts
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+# 2024 年 MoonBit 全球编程创新挑战赛游戏赛道提交仓库
+
+赛事详情与报名方式见：<https://tianchi.aliyun.com/s/42503d88fe6e219f3260251114461b54>
+
+## 提交流程
+
+1. 创建本仓库的 fork
+1. 在 teams 文件夹下以自己的队伍名创建文件夹
+1. 文件夹中至少包含以下文件：
+   - `game.wasm`: 编译后的游戏本体
+   - `README.md`: 游戏描述及说明
+1. 提交 PR
+
+## 提交文件及作用
+
+除了上面提到的 `game.wasm` 和 `README.md` 以外，选手提交的文件夹还可以包含以下文件：
+
+- `control`：utf-8 编码的文本文件，说明游戏的控制方法
+- `title`：utf-8 编码的文本文件，游戏的标题
+- `cover.png`：游戏封面图片，会在展示页面渲染
+
+这些文件可以控制提交的游戏在展示页和详情页的渲染，具体作用如下图所示
+
+![](./imgs/gallery.png)
+
+![](./imgs/game.png)
+
+## 如果你有任何问题，请在 issue 中提问
diff --git a/dev/data.json b/dev/data.json
diff --git a/imgs/gallery.png b/imgs/gallery.png
diff --git a/imgs/game.png b/imgs/game.png
diff --git a/src/build.mts b/src/build.mts
@@ -74,7 +74,7 @@ function getPrNumber(teamName: string): number {
 
 async function collectMetaInfo(teamName: string): Promise<MetaInfo> {
   const prInfo = process.env.DEV
-    ? JSON.parse(fs.readFileSync('data.json', 'utf8'))
+    ? JSON.parse(fs.readFileSync('dev/data.json', 'utf8'))
     : await getPRInfo(teamName)
 
   const metaInfo: MetaInfo = {

diff --git a/teams/MoonBit官方样例1/LICENSE b/teams/MoonBit官方样例1/LICENSE