Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lcui-dev/lcui-quick-start
Clone to try a simple LCUI app
https://github.com/lcui-dev/lcui-quick-start
c cmake gui-application lcpkg lcui xmake
Last synced: 2 months ago
JSON representation
Clone to try a simple LCUI app
- Host: GitHub
- URL: https://github.com/lcui-dev/lcui-quick-start
- Owner: lcui-dev
- License: cc0-1.0
- Created: 2019-09-13T06:55:28.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2024-09-12T02:23:55.000Z (3 months ago)
- Last Synced: 2024-09-12T12:08:40.255Z (3 months ago)
- Topics: c, cmake, gui-application, lcpkg, lcui, xmake
- Language: C
- Homepage:
- Size: 166 KB
- Stars: 7
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# lcui-quick-start
[](https://github.com/lcui-dev/lcui-quick-start/actions/workflows/ccpp.yml)
(**English**/[中文](README.zh-cn.md))
**Clone and run for a quick way to see LCUI in action.**
## To Use
To clone and run this repository you'll need install the following tools on your computer:
- [Git](https://git-scm.com)
- [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com))
- [XMake](https://xmake.io/)
From your command line:
```bash
# Install command line tool
npm install -g @lcui/cli
# Clone this repository
git clone https://github.com/lcui-dev/lcui-quick-start.git
# Go into the repository
cd lcui-quick-start
# Install dependencies
npm install
# Build
lcui build
# Run the app
xmake run app
```
## What's included
- `app/`: Directory for storing source code and resources based on application routers.
- `about/`: Directory for the about page.
- `logo.png`: Project icon file.
- `page.c`: C source file for the about page.
- `page.h`: C header file for the about page.
- `page.tsx`: TypeScript source file for the about page.
- `page.tsx.h`: page.tsx compiled into C source code, included by page.c.
- `styles.module.scss`: CSS module.
- `styles.module.scss.h`: CSS module compiled into C code, included by page.tsx.h.
- `global.css`: Global CSS styles.
- `page.c`: C source file for the main page.
- `page.h`: C header file for the main page.
- `page.tsx`: TypeScript source file for the main page.
- `page.tsx.h`: page.tsx compiled into C code, included by page.c.
- `layout.tsx`: Layout containing UI shared with subpages.
- `main.c`: Main entry source file containing the source code for `main()` function.
- `main.h`: Main entry header file containing headers and functions required by `main()` function.
- `.clang-format`: Code formatting configuration file.
- `xmake.lua`: Configuration file for [XMake](https://xmake.io/).
- `package.json`: Description of the basic information and dependencies of the application.
- `tailwind.config.js`: Configuration file for [Tailwind CSS](https://tailwindcss.com/), enabling only partial plugins for LCUI features.
- `postcss.config.js`: Configuration file for [PostCSS](https://postcss.org/).
- `version.rc`: Resource file describing the icon and information of the Windows executable.
- `logo.ico`: Icon file for the Windows executable.
- `tsconfig.json`: [TypeScript configuration file](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html).
## License
[CC0 1.0 (Public Domain)](LICENSE.md)