修改readme文件

This commit is contained in:
hewenfei 2023-04-09 20:03:40 +08:00
parent 9d6a1dd5b4
commit add2e6c597
1 changed files with 4 additions and 81 deletions

View File

@ -1,84 +1,7 @@
# ukui-menu
![build](https://github.com/ukui/ukui-menu/workflows/Check%20build/badge.svg?branch=master)
An advanced menu for UKUI, providing common and all software mixed sort module, alphabet classification module, functional classification module and search module. Provides favorites and recent file functions, You can fix it to your favorites area by right-clicking the application. Provides two display modes: default window and full-screen window.
# The project structure
## data/img
Provide icon files for the projec.
## src/BackProcess
Background data processing function realization, Includes DBUS, path listening, data acquisition, and search functions.
## src/QtSingleApplication
Singleton pattern processing.
## src/UserInterface
The UI implementation.
## src/UtilityFunction
Implementation of common functions, including database operations.
## translations
Translation files
# How to report bugs
Bugs should be reported to the UKUI bug tracking system:
https://gitee.com/openkylin/ukui-menu/issues
You will need to create an account for yourself.
Please read the HACKING file for information on where to send changes or
bugfixes for this package.
# How to build
## Preparation
You can build pre-depends with such command:
`sudo apt install g++ qtbase5-dev qttools5-dev-tools libglib2.0-dev libqt5svg5-dev libqt5x11extras5-dev libgsettings-qt-dev libbamf3-dev libxrandr-dev libxtst-dev libx11-dev libkf5windowsystem-dev libuchardet-dev libpeony-dev libkysdk-waylandhelper-dev libukui-common-dev`
Note: build-depends references the paragraph in debian/control.
## Build from source and test
> git clone https://gitee.com/openkylin/ukui-menu.git
> cd ukui-menu && mkdir build && cd build
> qmake .. && make
> sudo make install
Note: If you want to run ukui-menu, You just need to execute the ukui-menu command at the terminal.
# DBUS interface
BUS Nameorg.ukui.menu
path/org/ukui/menu
Interfaceorg.ukui.menu
Method name
GetMenuStatus () <---> Get ukui-menu display hidden status
WinKeyResponse () <---> ukui-menu display hidden state change interface
GetSecurityConfigPath () <---> Get security control profile path
# Configuration file
.config/ukui/Ukuimenu.db
```c++
hi, wellcome to new ukui-menu 4.0.0.0.
```
### To be continued...