Skip to content

Commit e260284

Browse files
committed
update example note
1 parent 5ee0281 commit e260284

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

docs/v0.1.0/en/examples/overview.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ All official examples are stored in [made_with_GenUI](https://github.com/Privoce
1414
- [Source Code: settings](https://github.com/Privoce/made_with_GenUI/blob/main/tests/settings/views/home.gen)
1515
- [Source Code: todo app (`network` plugin)](https://github.com/Privoce/made_with_GenUI/blob/main/tests/todo)
1616

17+
### Notes on running official examples
18+
19+
1. Modify the absolute path in the example `gen_ui.toml` to your path
20+
1. `[makepad.root] path`: Modify the `root.gen` file address
21+
2. `[makepad.dependencies] makepad-widgets`: Modify `makepad` dependencies
22+
2. Use `Ract` to run the `ract run` command to generate the compiled result
23+
1724
## Share Examples
1825

1926
We welcome you to share both code snippets and complete projects. Please add the following content to `AUTH.md` when sharing:

docs/v0.1.0/zh/examples/overview.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@
1414
- [settings页面源码](https://github.com/Privoce/made_with_GenUI/blob/main/tests/settings/views/home.gen)
1515
- [待办事项示例源码](https://github.com/Privoce/made_with_GenUI/blob/main/tests/todo)
1616

17+
### 运行官方示例须知
18+
19+
1. 修改例子中`gen_ui.toml`中的绝对路径为您的路径
20+
1. `[makepad.root] path`: 修改`root.gen`文件地址
21+
2. `[makepad.dependencies] makepad-widgets`: 修改`makepad`依赖
22+
2. 使用`Ract`运行`ract run`命令以生成编译后结果
23+
1724
## 分享示例
1825

1926
无论是代码片段还是完整的项目我们都欢迎您能分享,在分享时请在`AUTH.md`中添加如下内容:

0 commit comments

Comments
 (0)