diff --git a/ReadMe.md b/ReadMe.md new file mode 100644 --- /dev/null +++ b/ReadMe.md @@ -0,0 +1,62 @@ +# Plasma Active Window Control + +This widget add close/maximize/minimize buttons for the active window. It also displays the window title and icon, with the ability to show the global menu as well. Originally written by @kotelnik on GitHub. + +* All Bugs + https://bugs.kde.org/buglist.cgi?list_id=1556771&product=Active%20Window%20Control +* New Bug + https://bugs.kde.org/enter_bug.cgi?product=Active%20Window%20Control + +You can also send Pull Requests as normal diffs (`git diff`) via Phabricator. + +* Phabricator + https://phabricator.kde.org/source/plasma-active-window-control/ +* Pull Requests + https://phabricator.kde.org/differential/query/sv1JhxTYnBq6/#R +* New PR (Repo: Active Window Control Applet for Plasma) + https://phabricator.kde.org/differential/diff/create/ + + +### Install + +In order to install the widget, first download the new codebase: + +``` +git clone https://github.com/KDE/plasma-active-window-control +cd plasma-active-window-control +``` + +TODO: I'll need to figure out the exact build dependencies. For now, something like the following may install most of them. I'll need to test in an fresh KDE Neon install. + +``` +sudo apt-get build-dep plasma-pa +sudo apt-get build-dep kwin +``` + +Then build it. + +``` +mkdir build +cd build +cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=OFF -DKDE_INSTALL_USE_QT_SYS_PATHS=ON +make +sudo make install +``` + +### Update + +``` +cd plasma-active-window-control +git pull origin master --ff-only +``` + +Then run the build commands in under the install instructions again. + +### Uninstall + +``` +cd plasma-active-window-control +cd build +sudo make uninstall +``` +