Skip to content
This repository was archived by the owner on Jun 17, 2024. It is now read-only.

Commit 1ec26a4

Browse files
committed
docs: update README.md
1 parent ed236c8 commit 1ec26a4

File tree

3 files changed

+22
-14
lines changed

3 files changed

+22
-14
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# lc-router-app
1+
# lcui-router-app
22

33
(**English**/[中文](README.zh-cn.md))
44

5-
**Clone and run for a quick way to see LCUI Router in action.**
5+
A very simple browser-like application to show the LCUI and LCUI Router features.
6+
7+
[![Screenshot](./screenshot.gif "Screenshot")](./screenshot.gif)
68

79
## To Use
810

@@ -21,10 +23,10 @@ From your command line:
2123

2224
```shell
2325
# Clone this repository
24-
git clone https://github.com/lc-ui/lc-router-app
26+
git clone https://github.com/lc-ui/lcui-router-app
2527
2628
# Go into the repository
27-
cd lc-router-app
29+
cd lcui-router-app
2830
2931
# Install NodeJS dependencies
3032
npm install
@@ -43,13 +45,16 @@ lcpkg run start --mode debug
4345
- Configuration files for [CMake](https://cmake.org/) and [XMake](https://xmake.io/) build tools, You can choose one of them that you like.
4446
- Simple data storage implementation in `src/lib/store.c`.
4547
- [.scss](https://sass-lang.com/guide) files for describe the user interface style.
46-
- `about` component for display app infomation.
47-
- `home` view that implements simple layout and interaction.
48+
- Implementation of the browser's graphical interface.
49+
- Welcome page, about page, file page, 404 page, new tab page.
50+
- Example for the routing navigation of the [LCUI Router](https://github.com/lc-soft/lcui-router).
51+
- Examples of use of the [LC Design](https://github.com/lc-ui/lc-design) component library.
4852
4953
## Project Structure
5054
5155
- **`app`**: contains the resource files required for the application to run. You can use it as the working directory of the application, and when you publish your application, you only need to package the files in that directory.
5256
- **`build`**: contains build tool output files.
57+
- **`config/router.js`**: Configuration file for the LCUI Router, it can be compiled into a `src/lib/router.c` file using the `lcui compile router` command.
5358
- **`scripts`**: contains build-related scripts and configuration files.
5459
- **`src`**: contains the source code.
5560
- **`ui`**: contains source code related to the user interface.

README.zh-cn.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# lc-design-app
1+
# lcui-router-app
22

33
([English](README.md)/**中文**)
44

5-
**克隆并运行以快速查看 LCUI 的运行方式以及 LC Design 组件库的效果。**
5+
一个仿浏览器界面的应用程序,用于展示 LCUI 的图形界面渲染能力和 LCUI Router 的路由导航功能。
6+
7+
[![运行效果图](./screenshot.gif "运行效果图")](./screenshot.gif)
68

79
## 使用
810

@@ -21,10 +23,10 @@
2123

2224
```bash
2325
# 克隆这个仓库
24-
git clone https://github.com/lc-ui/lc-design-app
26+
git clone https://github.com/lc-ui/lcui-router-app
2527
2628
# 进入仓库
27-
cd lc-design-app
29+
cd lcui-router-app
2830
2931
# 安装 NodeJS 依赖包
3032
npm install
@@ -41,16 +43,17 @@ lcpkg run start --mode debug
4143
- 一些资源文件。
4244
- 一些能方便你构建应用程序的脚本。
4345
- [CMake](https://cmake.org/) 和 [XMake](https://xmake.io/) 构建工具的配置文件,你可以选择其中一个你熟悉的来使用。
44-
- 简单的数据存储操作实现,在 `src/lib/store.c` 中可找到。
4546
- 用于描述用户界面样式的 [.scss](https://sass-lang.com/guide) 文件。
46-
- 用于显示应用程序信息的 `about` 组件。
47-
- 实现了简单布局和交互的 `home` 视图。
48-
- 提供 [LC Design](https://github.com/lc-ui/lc-design) 组件库的一些组件效果预览的 `preview` 视图。
47+
- 浏览器界面的简单实现。
48+
- 欢迎页面、关于页面、文件浏览页面、404 页面、新标签页面。
49+
- [LCUI Router](https://github.com/lc-soft/lcui-router) 的路由导航功能示例。
50+
- [LC Design](https://github.com/lc-ui/lc-design) 组件库的使用示例。
4951

5052
## 项目结构
5153

5254
- **`app`**: 包含应用程序运行所需的资源文件。你可以将它当成应用程序的工作目录,在发布应用程序时你只需要打包这个目录内的文件。
5355
- **`build`**: 包含构建工具输出的文件。
56+
- **`config/router.js`**: LCUI Router 的配置文件,可使用 `lcui compile router` 命令将其编译为 `src/lib/router.c` 文件。
5457
- **`scripts`**: 包含构建相关的脚本和配置文件。
5558
- **`src`**: 包含源代码。
5659
- **`ui`**: 包含用户界面相关的源代码。

screenshot.gif

275 KB
Loading

0 commit comments

Comments
 (0)