Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lc-soft committed Dec 16, 2023
1 parent 178af77 commit a6f62af
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 22 deletions.
32 changes: 10 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,44 +17,32 @@ To clone and run this repository you'll need install the following tools on your
From your command line:

```bash
# Clone this repository
git clone https://github.com/lc-ui/lcui-quick-start
# Install command line tool
npm install -g @lcui/cli

# Go into the repository
cd lcui-quick-start

# Update git submodule
git submodule sync --recursive
git submodule update --init --recursive

# Compile resource files
lcui compile ./src

# Build
xmake

# Run
xmake run
# Create project
lcui create my-lcui-app
```

## What's included

- Some resource files.
- Some scripts that make it easy for you to quickly build application.
- Configuration file for [XMake](https://xmake.io/).
- Simple data storage implementation in `src/lib/store.c`.
- [.scss](https://sass-lang.com/guide) files for describe the user interface style.
- `about` component for display app infomation.
- `home` view that implements simple layout and interaction.
- Some tsx files used to describe the structure of the user interface. You can refer to it to write stateless components using the TypeScript language and React library.
- `about` component for display app information.
- `home` page that implements simple layout and interaction.

## Project Structure

- **`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.
- **`build`**: contains build tool output files.
- **`src`**: contains the source code.
- **`assets`**: contains resource files.
- **`style`**: contains the source code of stylesheets. You can put [.scss](https://sass-lang.com/guide) files here.
- **`components`**: contains the source code of the components.
- **`views`**: contains the source code of the views.
- **`components`**: Contains source code for components.
- **`pages`**: Contains source code for pages.
- **`lib`**: contains the base library code.

## License
Expand Down
1 change: 1 addition & 0 deletions README.zh-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ lcui create my-lcui-app
- **`app`**: 包含应用程序运行所需的资源文件。你可以将它当成应用程序的工作目录,在发布应用程序时你只需要打包这个目录内的文件。
- **`build`**: 包含构建工具输出的文件。
- **`src`**: 包含源代码。
- **`assets`**: 包含资源文件。
- **`style`**: 包含样式表的源代码。你可以将 [.scss](https://sass-lang.com/guide) 文件放到这里。
- **`components`**: 包含组件的源代码。
- **`pages`**: 包含页面的源代码。
Expand Down

0 comments on commit a6f62af

Please sign in to comment.