lcui-quick-start

(English/中文)

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
• Node.js (which comes with npm)
• XMake

From your command line:

# 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

# Download submodules
git submodule sync --recursive
git submodule update --init --recursive

# 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.
• package.json: Description of the basic information and dependencies of the application.
• tailwind.config.js: Configuration file for Tailwind CSS, enabling only partial plugins for LCUI features.
• postcss.config.js: Configuration file for PostCSS.
• 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.

License

CC0 1.0 (Public Domain)