From d580df0c3d6da705e43bdffb2dfe9af16ac09255 Mon Sep 17 00:00:00 2001 From: dou33 Date: Fri, 19 Jun 2020 14:32:17 +0800 Subject: [PATCH] update README.en.md. --- README.en.md | 71 +++++++++++++++++++++++++++++----------------------- 1 file changed, 40 insertions(+), 31 deletions(-) diff --git a/README.en.md b/README.en.md index 40fac22..ee6780c 100644 --- a/README.en.md +++ b/README.en.md @@ -1,36 +1,45 @@ # ukui-sidebar +The sidebar mainly consists of two parts: notification center and cutting board. It starts from the start-up and is placed in the tray bar in the form of a tray. After clicking, it can pop up dynamically from the right side of the screen. -#### Description -{**When you're done, you can delete the content in this README and update the file with details for others getting started with your repository**} - -#### Software Architecture -Software architecture description - -#### Installation - -1. xxxx -2. xxxx -3. xxxx - -#### Instructions - -1. xxxx -2. xxxx -3. xxxx - -#### Contribution - -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request + + The notification center can display the pop-up messages sent by each application to mate notification teamon in a list form. Unimportant information can be stored in the storage box for viewing. At the same time, it can call the control panel directly. -#### Gitee Feature + + The main function of the clipboard is to save the latest cutting information, and display it under the sidebar in the form of a list. At the same time, it can also put the previous cutting information at the top, so that it can be pasted directly. In addition, it can record the cut text information as well as the URL. -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +The ukui-sidebar is a shortcut tool on the right side of the screen for UKUI. + +# How to test notification-center +`notify-send -a wechat -i "/home/ccn/heart.png" Summary Body` + +# How to report bugs +Bugs should be reported to the UKUI bug tracking system: + + https://github.com/ukui/ukui-sidebar/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 libglib2.0-dev qtbase5-dev libqt5svg5-dev qttools5-dev-tools` + +Note: build-depends references the paragraph in debian/control. + +## Build from source and test + +> git clone https://github.com/ukui/ukui-sidebar + +> cd ukui-sidebar && mkdir build && cd build + +> qmake .. && make + +> sudo make install + +Note: If you want to run ukui-sidebar, you need to make some changes in the code after build. + + Find `libnotification_plugin.so` in your build path like `/home/XX/ukui-sidebar/build/src/plugins/notification_plugins`. Then set this path as pluginDir in file widget.cpp fuction `bool Widget::loadNotificationPlugin()`. + + + Find `libclipboardPlugin.so` in your build path like `/home/XX/ukui-sidebar/build/src/plugins/sidebar_pushbutton_plugins`. Then set this path as pluginDir in file pluginmanage.cpp fuction `PluginManager::PluginManager(QObject *parent) : QObject(parent)`. \ No newline at end of file