Skip to content

Commit

Permalink
docs: update README.md for folder structure and build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
elysia-best committed Jan 23, 2025
1 parent 06128e3 commit d10310a
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,36 @@ LingmoUI is a GUI library based on QQC (Qt Quick Controls) and Qt 6, every Lingm

## Structures

- `Compatible`: This fold stores the old version of LingmoUI 1.0. (Will be removed in the future)
- `Compatible`: This folder stores the old version of LingmoUI 1.0. (Will be removed in the future)
- `LingmoStyle`: This folder stores QMLs for Qt Quick Controls 2 style.
- `src`: This folder stores the source code of LingmoUI.
- `Controls`: This folder stores the main QMLs of LingmoUI.
- `Image`: This folder stores the images of LingmoUI.
- `Font`: This folder stores the fonts of LingmoUI.
- `GraphicalEffects`: This folder stores the graphical effects implementation of LingmoUI.
- `example`: This folder stores the example app using LingmoUI.

## Dependencies

(Outdated, needs update here)
### Debian

```bash
sudo apt install libqt5x11extras5-dev libkf5windowsystem-dev qtbase5-private-dev libxcb1-dev libxcb-shape0-dev libxcb-icccm4-dev -y
sudo apt install devscripts equivs
sudo mk-build-deps -i -t "apt --yes" -r
```

### Windows

1. Install Qt 6.7 or higher, and set the environment variables.
2. Install ECM (Extra CMake Modules) from [here](https://invent.kde.org/frameworks/extra-cmake-modules). Build and install it to a proper directory. Set the environment variables CMAKE_PREFIX_PATH for ECM.
3. Clone this repository.
4. Open the Qt Creator and open the `CMakeLists.txt` file.
5. Build and run the example app.

## Build
Before build, make sure you have necessary Qt environment.

### Using Command Line
```bash
mkdir build
cd build
Expand All @@ -35,6 +52,10 @@ make
sudo make install
```

### Using Qt Creator

Open the `CMakeLists.txt` file in Qt Creator and build the project.

## Packaging

### Debian/Ubuntu
Expand Down

0 comments on commit d10310a

Please sign in to comment.